Quick Reference—Developer Guide - Palm webOS

type

String

Choices:

Mojo.Widget.defaultButton

Mojo.Widget.activityButton

disabledProperty

Boolean

Name of model property for disabled state

label

String

Displayed label

labelProperty

String

Model property name for label

buttonClass

label

String

Displayed label

disabled

Boolean

Default property that when true, disables the widget

Mojo.Event.tap

activate()

For an activity button, start the spinner

deactivate()

For an activity button, stop the spinner

modelProperty

String

Name of model property for widget state

disabledProperty

String

Name of model property for disabled state

trueValue

String

Value to set modelProperty when widget state is true

falseValue

String

Value to set modelProperty when widget state is false

inputName

String

Identifier for the value of the check box; used when the widget is used in HTML forms

value

Boolean

Current value of widget

disabled

Boolean

Default property that when true, disables the widget

Mojo.Event.propertyChange

label

String

Label displayed with the widget controls

labelPlacement

String

Choices are:

Mojo.Widget.labelPlacementLeft

Mojo.Widget.labelPlacementRight

modelProperty

String

Name of model property for date object; defaults to 'date'

month

Boolean

Set to true to display the month field in the widget

day

Boolean

Set to true to display the day field in the widget

year

Boolean

Set to true to display the year field in the widget

maxYear

minYear

date

Date

Date object set to the widget value

unstyled

Boolean

When set to true, prevents styles from being added, allowing the Drawer to be used just for open/close function

modelProperty

String

Name of model property for date object

open

Boolean

Current state of the widget; set to true when open

Mojo.Event.propertyChange

setOpenState(open)

Sets the open state to open or closed

getOpenState()

Returns current value of open state

toggleState()

Change the drawer’s open state to the opposite of what it is now

params

Object

Object containing information about the file to select as described below:

  onSelect

Function

Function to call after selection is made; it will return an object of the following format:

{ fullPath: /full/path/of/selected/file' }

  onCancel

Function

Function to call after selection is made; when picker is canceled.

  kinds

Array

Array of strings to allow (image, audio, video, file); default is support for all kinds; if only one kind is needed, kind: mytype can be used and override kinds

  defaultKind

String

String; the view to go to; one of image, audio, video or file

  actionType

String

attach and open are the only supported options; open is the default

  actionName

String

Overrides the default string defined by actionType

  extensions

Array

File extensions to filter in the files view

stageController

Object

The calling application’s stage assistant

None

delay

Integer

Delay between key strokes for a filter event, in milliseconds

disabledProperty

String

Name of model property for disabled state

disabled

Boolean

Default property that, when true, disables the widget

Mojo.Event.filter

open()

Open the widget

close()

Close the widget

setCount(integer)

Set the number to be shown in the results bubble in the Filter Field

delay

Integer

Delay between key strokes for a filter event, in milliseconds

filterFunction

Function

Function called to load items into the list as it is scrolled or filter changes; function definition is:

filterFunction(filterString, listWidget,
    offset, count)

where:

filterString: set to the input string

listWidget: this Filter Listwidget object

offset: index of first displayed entry in listfs

count; number of entries required from the function

listTemplate

String

File path relative to app folder for container template

itemTemplate

String

File path relative to app folder for item template

addItemLabel

String

If defined, a special “add” item will be appended to the list and taps on this will generate a Mojo.Event.listTap

formatters

Function

Object functions to format list entries based on model properties

itemsProperty

String

Model property for items list

swipeToDelete

Boolean

If true, list entries can be deleted with a swipe

autoconfirmDelete

String

If false, delete swipes will post a delete/undo button pair, otherwise deletes will be made immediately after swiping

uniquenessProperty

preventDeleteProperty

String

If specified, the item models will be checked for this property, and swipeToDelete will be ignored on that item if the item model’s property is true

reorderable

Boolean

If true, list entries can be reordered by drag and drop

dividerFunction

Function

Function to create divider elements

dividerTemplate

Function

Function to format divider

fixedHeightItems

Boolean

If false, list widget will not apply optimizations for fixed height lists

initialAverageRowHeight

Integer

Initial value used for average height estimation

renderLimit

Integer

Max number of items to render at once; increase this if the UI overruns the list boundaries

lookahead

Integer

Number of items to fetch ahead when loading new items

dragDatatype

String

Used for drag-and-drop reordering; if specified, will enable dragging of items from one list to another of the same data type

deletedProperty

String

Name of the item object property in which to store the deleted status of an item

nullItemTemplate

String

File path relative to app folder for template for items that are rendered before loading

emptyTemplate

String

File path relative to application folder for template for empty list

onItemRendered

Function

Called each time an item is rendered into the DOM with these arguments

disabled

Boolean

Default property that, when true, disables the widget

Mojo.Event.listChange
Mojo.Event.listTap
Mojo.Event.listAdd
Mojo.Event.listDelete
Mojo.Event.listReorder
Mojo.Event.filter

getList()

Get the List widget associated with this filter list

open()

Open the filter field associated with this filter list

close()

Close the filter field associated with this filter list

setCount(integer)

Set the number to be shown in the results bubble in the filter field

highResolutionLoad

Integer

Time to wait before switching photo to high res

noExtractFS

Boolean

Flag to prevent looking up a high res version

fslimitZoom

Boolean

Flag to prevent or limit zooming

onLeftFunction

Function

Called after a left scroll and transition

onRightFunction

Function

Called after a right scroll and transition

Mojo.Event.imageViewChanged

getCurrentParams()

Return the current zoom level and focus [0,1]

manualSize(width, height)

Manually size the widget

leftUrlProvided(url)

Set the image for the left scroll

rightUrlProvided(url)

Set the image for the right scroll

centerUrlProvided(url)

Set the image for the center

label

String

Label displayed with the widget controls

labelPlacement

String

Choices are:

Mojo.Widget.labelPlacementLeft

Mojo.Widget.labelPlacementRight

modelProperty

String

Name of model property for integer value; defaults to 'value'

min

Integer

Minimum value of the widget

max

Integer

Maximum value of the widget

padNumbers

Boolean

Add padding to single digit numbers or not

value

Integer

Current value of the widget

Mojo.Event.propertyChange

listTemplate

String

File path relative to app folder for container template

itemTemplate

String

File path relative to app folder for item template

addItemLabel

String

If defined, a special “add” item will be appended to the list and taps on this will generate a Mojo.Event.listTap

formatters

Function

Object functions to format list entries based on model properties

itemsProperty

String

Model property for items list

itemsCallback

Function

Items will be loaded as needed by calling this function

swipeToDelete

Boolean

If true, list entries can be deleted with a swipe

autoconfirmDelete

String

If false, delete swipes will post a delete/undo button pair, otherwise deletes will be made immediately after swiping

uniquenessProperty

preventDeleteProperty

String

If specified, the item models will be checked for this property, and swipeToDelete will be ignored on that item if the item model’s property is true

reorderable

Boolean

If true, list entries can be reordered by drag and drop

dividerFunction

Function

Function to create divider elements

dividerTemplate

Function

Function to format divider

fixedHeightItems

Boolean

If false, list widget will not apply optimizations for fixed height lists

initialAverageRowHeight

Integer

Initial value used for average height estimation

renderLimit

Integer

Max number of items to render at once; increase this if the UI overruns the list boundaries

lookahead

Integer

Number of items to fetch ahead when loading new items

dragDatatype

String

Used for drag-and-drop reordering; if specified, will enable dragging of items from one list to another of the same data type

deletedProperty

String

Name of the item object property in which to store the deleted status of an item

nullItemTemplate

String

File path relative to app folder for template for items that are rendered before loading

emptyTemplate

String

File path relative to application folder for template for empty list

onItemRendered

Function

Called each time an item is rendered into the DOM with these arguments

items

Array

An array of objects to display in the list; required unless itemsCallback property is set as an attributes property

Mojo.Event.listChange
Mojo.Event.listTap
Mojo.Event.listAdd
Mojo.Event.listDelete
Mojo.Event.listReorder

focusItem(itemModel, focusSelector)

Focus the item designated by the item model; optionally pass in the focusSelector to focus a specific element within the item

showAddItem(enable)

Show the “add item” in the list

noticeUpdatedItems(offset, items)

Causes the given items to be replaced and rerendered; items provided past the current end of the list will cause the length to grow; must pass an array

noticeAddedItems(offset, items)

Inserts the given array of items into the list at the given offset; if list items are dynamically loaded, this may cause some to be kicked out of the cache; calling this API will not cause a property-change event to be fired

noticeRemovedItems(offset, items)

Removes items from the list beginning at the given offset, and continuing for limit items; if list items are dynamically loaded, this may cause new ones to be requested; calling this API will not cause a property-change event to be fired

getNodeByIndex(index)

Return top level node for the list item of the given index; returns undefined if the item does not exist or is not currently rendered

invalidateItems(offset, limit)

Causes the given items to be reloaded (if currently loaded); if limit is unspecified, causes all items after offset to be invalidated

getLoadedItemRange()

Returns a hash with offset and limit properties indicating the range of currently loaded item models (or items that have been requested); this is sometimes used on the service side to optimize subscription data

getMaxLoadedItems()

Returns the maximum number of loaded items the list will maintain in its local cache

setInitialSize(length)

Call to set the initial size of the list, or after resetting the list state by calling modelChanged(); this function will set the limit on what range of items may be requested, but subsequent changes to the list size should be made through noticeAddedItems() and fsnoticeRemovedItems(); this function has no affect when the list size != 0

setLength(length)

Call to set the overall length of the list; this function will set the range of items that may be requested, but will generally not invalidate any existing items or request any new ones; it may request new items when the currently loaded items window is either not full, or the length change causes the items window to move (the latter case can occur if the length change causes the window to be “out of bounds”, or if it would ideally be positioned past the end of the list)

setLengthAndInvalidate(length)

Behaves like setLength(), except that all currently loaded items are invalidated; for lazily loaded lists, this API will result in a request for a whole window of items

getLength()

Returns the current length of the list

revealItem(index, animate)

Attempts to scroll the scene to reveal the item with the given index; may behave poorly when working with variable height list items that are not currently loaded, since you can’t accurately predict the height of the final rendered content

getItemByNode(node)

Returns the item model associated with the list item containing the given node, if any; otherwise, returns undefined

modelProperty

String

Name of model property for widget state

disabledProperty

String

Name of model property for disabled state

multi-line

Boolean

If true, long labels will wrap to the next line instead of being truncated

label

String

Display label

labelPlacement

String

Mojo.Widget.labelPlacementRight places label on right, value on left (default);

Mojo.Widget.labelPlacementLeft places label on left, value on right

choices

Array

Array of selector descriptions, which must be in either the attributes or model object; each entry is required to be:

{label: 'string', value: value}

There must be at least two entries, and the number of entries defines the number of options presented in the widget

value

Boolean

Current value of widget

disabled

Boolean

Default property that, when true, disables the widget

choices

Array

Array of selector descriptions, which must be in either the attributes or model object; each entry is required to be:

{label: 'string', value: value}

There must be at least two entries, and the number of entries defines the number of options presented in the widget

Mojo.Event.propertyChange

modelProperty

Boolean

Name of model property for widget value

hintText

String

Initially displayed string; supplanted by model value if supplied

inputName

String

If supplied, the text area will have this DOM name so that when it is serialized, the property can be easily pulled out

charsAllow

Function

Function must return true to allow input character, or false if not allowed

autoFocus

Boolean

If true, field has focus on scene push

modifierState

String

Initial state of modifier keys for this field; can be: Mojo.Widget.numLock or Mojo.Widget.capsLock

growWidth

Boolean

Automatically grow field horizontally

autoResizeMax

String

Maximum width of field

enterSubmits

Boolean

If set, the Enter key will submit rather than newline; must be used with multi-line

limitResize

Boolean

Limit height resize (scrolls text rather than grow field)

preventResize

Boolean

There will be no resizing in any dimension

holdToEnable

Boolean

If the text field is disabled, tapping and holding and releasing will enable it; if disabled is not set, this is ignored

focusMode

String

Replace or Insert Mode; choices are:

Mojo.Widget.focusSelectMode
Mojo.Widget.focusInsertMode
Mojo.Widget.focusAppendMode

changeOnKeyPress

Boolean

If true, sends a property change event on every character change to a field; otherwise only when field loses focus

maxLength

Integer

Maximum character length of field; does not apply to multi-line fields, where it will be ignored

requiresEnterKey

Boolean

Required Enter key to submit; other navigation will not submit contents of field

holdToEdit

Boolean

Tap and hold to focus/edit; tap only will be ignored

value

Boolean

Plain-text value of the widget

Mojo.Event.propertyChange

focus()

Put focus on the input field

blur()

Remove focus from the input field

getValue()

Get the plaintext value of the widget

setValue()

Set the plaintext value of the widget

getCursorPosition()

Returns an option with:

{selectionStart: int, selectionEnd: int}

that describe the position of the cursor; if start is not equal to end, there is text selected

setCursorPosition(start, end)

Sets the cursor position in the input portion of the text field

modelProperty

String

Name of model property for widget value

icon

String

CSS class for icon to display on the bar

iconPath

String

File path relative to application folder for icon

value

Integer

Value of the widget

title

String

Dynamic title to show on bar

image

String

File path relative to application folder for dynamic image to show on bar

Mojo.Event.progressComplete

reset()

Reset progress to 0

cancelProgress()

Stop the progress and freeze bar display in current state

modelProperty

String

Name of model property for widget value

title

String

Title to show on bar

image

String

File path relative to application folder for image to show on bar

icon

String

CSS class for icon to display on the bar

iconPath

String

File path relative to application folder for icon

value

Integer

Value of the widget

title

String

Dynamic title to show on bar

image

String

File path relative to application folder for dynamic image to show on bar

Mojo.Event.progressIconTap
Mojo.Event.progressComplete

reset()

Reset progress to 0

cancelProgress()

Stop the progress and freeze bar display in current state

sliderProperty

String

Name of model property for slider position value

progressProperty

String

Name of model property for progress position value

progressStartProperty

Integer

Starting position of progress bar

minValue

Integer

Starting value, or leftmost value on the slider

maxValue

Integer

Ending value, or rightmost value on the slider

round

Boolean

If true, will round the value to the nearest integer

updateInterval

Integer

If set >0, the widget will send events every updateInterval seconds

value

Integer

Value of the widget

Mojo.Event.propertyChange
Mojo.Event.progressComplete

reset()

Reset progress to 0

modelProperty

String

Name of model property for widget state

disabledProperty

String

Name of model property for disabled state

choices

Array

Array of button descriptions; each entry is required to be:

{label: 'string', value: value}

The number of entries defines the number of buttons presented in the widget

value

Boolean

Current value of widget

disabled

Boolean

Default property that, when true, disables the widget

Mojo.Event.propertyChange

None

value

Boolean

Current value of widget

mode

String

Scrolling mode; one of free, vertical, horizontal, dominant, vertical-snap, or horizontal-snap

snapElements

Array

Array of DOM elements used as snap points for horizontal or vertical scrolling

Mojo.Event.propertyChange

revealTop(newTop)

Jumps the scroll to reveal the top of the specified object at the top of the scroll area

revealBottom()

Jumps the scroll to reveal the bottom of the content being scrolled

revealElement(Element)

Jumps the scroll to reveal a specific DOM element

scrollTo(x-coord, y-coord, animated, 
suppressNotification)

Jumps the scroll to the specified x- and y-coordinates; set animated to true to animate the scroll, or if animated is false, set suppressNotification to true to prevent notifications to event listeners

getState()

Returns the current scroll state for use in a future call to setState()

setState(scrollState, animate)

Jumps the scroll to the value specified in scrollState; pass true to animate the scroll

adjustBy(deltaX, deltaY)

Adjusts the current scroll position by the given amount; safe to call from scroll listeners while animating; does not cause listeners to be notified of any changes

scrollerSize

Returns the size of the scroller’s view port in pixels:

{height:nnn, width:nnn}

setMode(newMode)

Set the mode of the scroller, which controls which drag directions causes scrolling; choices are free, dominant, horizontal, horizontal-snap, vertical, and vertical-snap

getScrollPosition()

Get the current position of the scroller; returns:

{left: nnn px, top: nnn px}

setSnapIndex(snapIndex, animate)

Sets the snap index for a snap scroller and scrolls to the new position; pass true to animate

modelProperty

String

Name of model property for widget value

minValue

Integer

Starting value, or leftmost value on the slider

maxValue

Integer

Ending value, or rightmost value on the slider

round

Boolean

If true, will round the value to the nearest integer

updateInterval

Integer

If set >0, the widget will send events every updateInterval seconds

value

Integer

Value of the widget

Mojo.Event.propertyChange

modelProperty

String

Name of model property for widget state

spinnerSize

String

Choices are:

Mojo.Widget.spinnerLarge
Mojo.Widget.spinnerSmall

superClass

String

Specifies the CSS class name for the background image with a custom spinner

startFrameCount

Integer

With a custom spinner, this is set to the number of frames for the preloop animation

mainFrameCount

Integer

With a custom spinner, this is set to the number of frames for the main loop animation

finalFrameCount

Integer

With a custom spinner, this is set to the number of frames for the post-loop animation

frameHeight

Integer

Explicitly sets the height of the animation

fps

Integer

Frames per second of the main loop animation

spinning

Boolean

Spinner state; set to true if spinning

Mojo.Event.propertyChange

start()

Start the spinner

stop()

Stop the spinner

toggle()

Change the spinner from start to stop or from stop to start

modelProperty

Boolean

Name of model property for widget value

disabledProperty

String

Name of model property for disabled state

hintText

String

Initially displayed string; supplanted by model value if supplied

inputName

String

If supplied, the text area will have this DOM name so that when it is serialized, the property can easily be pulled out

charsAllow

Function

Function must return true to allow input character, or false if not allowed

autoFocus

Boolean

If true, field has focus on scene push

modifierState

String

Initial state of modifier keys for this field; can be: Mojo.Widget.numLock or Mojo.Widget.capsLock

growWidth

Boolean

Automatically grow field horizontally

autoResizeMax

String

Maximum width of field

enterSubmits

Boolean

If set, the Enter key will submit rather than newline; must be used with multi-line

limitResize

Boolean

Limit height resize (scrolls text rather than grow field)

preventResize

Boolean

There will be no resizing in any dimension

holdToEnable

Boolean

if the text field is disabled, tapping and holding and releasing will enable it; if disabled is not set, this is ignored

focusMode

String

Replace or Insert Mode; choices are:

Mojo.Widget.focusSelectMode
Mojo.Widget.focusInsertMode
Mojo.Widget.focusAppendMode

changeOnKeyPress

Boolean

If true, sends a property change event on every character change to a field; otherwise only when field loses focus

maxLength

Integer

Maximum character length of field; does not apply to multi-line fields, where it will be ignored

requiresEnterKey

Boolean

Requires Enter key to submit; other navigation will not submit contents of field

holdToEdit

Boolean

Tap and hold to focus/edit; tap only will be ignored

emoticons

Boolean

Enable emoticons on this field

autoReplace

Boolean

Whether to enable the Smart Text Engine services

textCase

String

Options are:

Mojo.Widget.steModeSentenceCase
Mojo.Widget.steModeTitleCase
Mojo.Widget.steModeLowerCase

value

Boolean

Value of the widget

disabled

Boolean

Default property that when true, disables the widget

Mojo.Event.propertyChange

focus()

Put focus on the input field

blur()

Remove focus from the input field

getValue()

Get the plain-text value of the widget

setValue(String)

Set the plain-text value of the widget

getCursorPosition()

Returns an option with:

{selectionStart: int, selectionEnd: int}

that describe the position of the cursor; if start is not equal to end, there is text selected

setCursorPosition(start, end)

Sets the cursor position in the input portion of the text field

label

String

Label displayed with the widget controls

labelPlacement

String

Choices are:

Mojo.Widget.labelPlacementLeft

Mojo.Widget.labelPlacementRight

modelProperty

String

Name of model property for date object; defaults to 'time'

minuteInterval

Integer

Interval between minute selections

time

Date

Date object set to the widget value

Mojo.Event.propertyChange

modelProperty

String

Name of model property for widget state

disabledProperty

String

Name of model property for disabled state

trueValue

String

Value to set modelProperty when widget state is true

trueLabel

String

Label when widget state is true

falseValue

String

Value to set modelProperty when widget state is false

falseLabel

String

Label when widget state is false

inputName

String

Identifier for the value of the check box; used when the widget is used in HTML forms

value

Boolean

Current value of widget

disabled

Boolean

Default property that, when true, disables the widget

Mojo.Event.propertyChange

virtualpageheight

Integer

The browser’s virtual page height

virtualpagewidth

Integer

The browser’s virtual page width

url

String

The initial URL to display

pageIdentifier

Function

The BrowserServer page identifier; this is used when the Browser Server instructs an application to open a new URL

minFontSize

Integer

The minimum font size that the browser will display

topMargin

Integer

The margin above the web view that is scrolled off the screen when a new page is loaded

cacheAdapter

Boolean

If true, cache this adapter, false if not, or undefined to not specify and use the browser-adapter default; default is undefined

interrogateClicks

Boolean

Use to call the host application for every hyperlink click via Mojo.Event.webViewLinkClicked

showClickedLink

Boolean

Styles clicked links with grey background and border

None

Mojo.Event.webViewLoadStarted
Mojo.Event.webViewLoadProgress
Mojo.Event.webViewLoadStopped
Mojo.Event.webViewDownloadFinished
Mojo.Event.webViewLinkClicked
Mojo.Event.webViewTitleUrlChanged
Mojo.Event.webViewTitleChanged
Mojo.Event.webViewUrlChanged
Mojo.Event.webViewCreatePage
Mojo.Event.webViewTapRejected
Mojo.Event.webViewScrollAndScaleChanged
Mojo.Event.webViewEditorFocused
Mojo.Event.webViewUpdateHistory
Mojo.Event.webViewSetMainDocumentError
Mojo.Event.webViewServerConnect
Mojo.Event.webViewServerDisconnect
Mojo.Event.webViewResourceHandoff
Mojo.Event.webViewFirstPaintComplete
Mojo.Event.webViewUrlRedirect
Mojo.Event.webViewModifierTap
Mojo.Event.webViewMimeNotSupported
Mojo.Event.webViewMimeHandoff

setTopMargin(margin)

Set the top margin (in pixels)

clearCache()

Clear browser cache

clearCookies()

Clear browser cookies

deleteImage(image)

Delete the image file specified by the argument

generateIconFromFile(src, dst, left, 
top, right, bottom)

Generate a 64 × 64 pixel icon from a portion of a source file; the output icon will be given a drop shadow and sheen consistent with other launcher icons

goBack()

Go to the previous page in the user’s browsing history

goForward()

Go to the next page in the user’s browsing history

openURL(url)

Open the specified URL in the WebView

reloadPage()

Reload the currently loaded page

resizeImage(src, dst, width, height)

Resize the input file to the specified width/height and write the new image to the specified output file

getHistoryState(onSuccess)

Asynchronous; retrieves the current history state from the Browser server; will call onSuccess with results

setBlockPopups(enable)

Set to true to block pop-ups

setAcceptCookies(enable)

Set to false to disable cookies

addUrlRedirect(urlRe, redirect, 
userData, type)

Add a URL redirect; when the browser server navigates to a URL matching urlRe and redirect is true, it will not navigate to that URL, and will instead send a Mojo.Event.webViewUrlRedirect event

addSystemRedirects(skippAppId)

Read the command resource handler table and send down redirect handler commands to the browser server

saveViewToFile(fname, left, top, 
width, height)

Save the specified view frame (in pixels) to the specified file

setEnableJavaScript(enable)

Set to false to disable JavaScript

stopLoad()

Stop loading the current page

clearHistory()

Clear browser history

setShowClickedLink(enable)

Set to true to enable launch of clicked links

message

String

Displayed message in a modal dialog

window

Element

Optional argument to specify the window to post the alert within; required in multistage applications

onChoose

message

String

Displayed message in a modal dialog

title

String

Title of the dialog box

preventCancel

Boolean

If true, back gesture or other alerts will not cancel the dialog box

choices

Array

Array of button descriptions; each entry is required to be:

{label: 'string', value: value, type: 'string', 
allowHTMLMessage: boolean}

The number of entries defines the number of buttons presented in the dialog box; the type property is set to one of the button classes (e.g., primary, secondary, affirmative, negative); allowHTMLMessage set to allow insertion of HTML if safe

allHTMLMessage

Boolean

If true, the message string will not have HTML escaped

template

String

File path to HTML template containing content for the dialog box; rendered with properties from this model object

assistant

Object

The dialog assistant responsible for running the dialog box, which must implement methods (setup, activate, deactivate, cleanup, and handleCommand)

preventCancel

Boolean

If true, back gesture or other alerts will not cancel the dialog box

omitDefaultItems

Boolean

If true, default menu items will not be added to this menu

richTextEditItems

Boolean

If true, the Edit menu will also include Bold/Italics/Underline

label

String

Currently not supported

visible

Boolean

Current visibility of this menu

Items

Object

Object containing items for this menu, structured as:

  label

String

User-visible label for this item, not rendered for groups

  icon

String

CSS class for icon to display in this item

  iconPath

String

Path to image to display in menu item, relative to application’s directory

  width

Integer

Calculated based on item’s width; specifies the width in pixels of this menu item; overrides default calculations; ignored for groups

  items

Boolean

If this is specified, this item is a group that visually ties the child items together

  toggleCmd

Boolean

Only used when items is specified; specify this property to make this group a toggle group; this string is the command of currently selected choice item in this group, and this property is modified by the widget when a different choice is made

  command

Boolean

Specify to make this item a choice; it will then respond to a user tap by sending a Mojo.Event.command through the commander chain with this string as the command property

  disabled

Boolean

Menu choice is disabled when this is true; only used for items that also specify command

  submenu

Boolean

Specify to make this item a submenu item; it will then respond to a user tap by displaying the named menu as a pop-up submenu

  template

String

Path to HTML template for custom content to be inserted instead of a standard menu item; the template is rendered using this item model object for property substitution

  checkEnabled

Boolean

If set to true, a Mojo.Event.commandEnable event will be sent through the commander chain each time this menu item is displayed or invoked via keyboard shortcut

Mojo.Event.command
Mojo.Event.commandEnable

spacerHeight

Boolean

If specified, the spacer DIV associated with this menu will be the given height in pixels

menuClass

Boolean

Alternate CSS style; default is palm-default

label

String

Currently not supported

visible

Boolean

Current visibility of this menu

items

Object

Object containing items for this menu, structured as:

  label

String

User-visible label for this item, not rendered for groups

  icon

String

CSS class for icon to display in this item

  iconPath

String

Path to image to display in menu item, relative to application’s directory

  width

Integer

Calculated based on item’s width; specifies the width in pixels of this menu item; overrides default calculations; ignored for groups

  items

Boolean

If this is specified, this item is a group that visually ties the child items together

  toggleCmd

Boolean

Only used when items is specified; specify this property to make this group a toggle group; this string is the command of currently selected choice item in this group, and this property is modified by the widget when a different choice is made

  command

Boolean

Specify to make this item a choice; it will then respond to a user tap by sending a Mojo.Event.command through the commander chain with this string as the command property

  disabled

Boolean

Menu choice is disabled when this is true; only used for items which also specify command

  submenu

Boolean

Specify to make this item a submenu item; it will then respond to a user tap by displaying the named menu as a pop-up submenu

  template

String

Path to HTML template for custom content to be inserted instead of a standard menu item; the template is rendered using this item model object for property substitution

  checkEnabled

Boolean

If set to true, a Mojo.Event.commandEnable event will be sent through the commander chain each time this menu item is displayed or invoked via keyboard shortcut

Mojo.Event.command
Mojo.Event.commandEnable

spacerHeight

Boolean

If specified, the spacer DIV associated with this menu will be the given height in pixels

menuClass

Boolean

Alternate CSS style; default is palm-default

label

String

Currently not supported

visible

Boolean

Current visibility of this menu

items

Object

Object containing items for this menu, structured as:

  label

String

User visible label for this item, not rendered for groups

  icon

String

CSS class for icon to display in this item

  iconPath

String

Path to image to display in menu item, relative to application’s directory

  width

Integer

Calculated based on item’s width; specifies the width in pixels of this menu item; overrides default calculations; ignored for groups

  items

Boolean

If this is specified, this item is a group that visually ties the child items together

  toggleCmd

Boolean

Only used when items is specified; specify this property to make this group a toggle group; this string is the command of currently selected choice item in this group, and this property is modified by the widget when a different choice is made

  command

Boolean

Specify to make this item a choice; it will then respond to a user tap by sending a Mojo.Event.command through the commander chain with this string as the command property

  disabled

Boolean

Menu choice is disabled when this is true; only used for items which also specify command

  submenu

Boolean

Specify to make this item a submenu item; it will then respond to a user tap by displaying the named menu as a pop-up submenu

  template

String

Path to HTML template for custom content to be inserted instead of a standard menu item; the template is rendered using this item model object for property substitution

  checkEnabled

Boolean

If set to true, a Mojo.Event.commandEnable event will be sent through the commander chain each time this menu item is displayed or invoked via keyboard shortcut

Mojo.Event.command
Mojo.Event.commandEnable

onChoose

Function

Called when user makes a choice and the pop-up is dismissed

placeNear

Element

Used to position the pop-up menu near the triggering element

toggleCmd

Boolean

Causes the appropriate item to appear with a checkmark; supported in top-level model for pop-ups

popupClass

String

CSS class for the pop-up menu, referenced from the HTML templates

scrimClass

String

CSS class for the pop-up scrim; defaults to submenu-popup

manualPlacement

Boolean

If true, pop-up menu will not be placed automatically (centered, or near placeNear element)

items

Array

Array of choices; each choice is an object with the following properties:

  label

  command

  secondaryIcon

  secondaryIconPath

  chosen

new Mojo.Model.Cookie(cookieName, optionalDocument)

cookieName

String

Name for the cookie; has an application scope so uniqueness across applications is not a requirement

optionalDocument

Object

Document element to store cookie; defaults to current document

get()

Returns the object stored in this cookie, or undefined if the cookie doesn’t exist

put(objectToStore, expirationDate)

Updates the value of this cookie with the passed object with an optional date object to set an expiration date; if no expiration date is set, the cookie will not expire

remove()

Deletes the cookie

new Mojo.Depot(options, onSuccess, onFailure)

options

Object

Options for opening or creating a depot, structured as:

  name

String

Name used to identify the underlying database; has an application scope; use 'ext:' prefix to create Depot in the /media partition

  version

Integer

Version number used for the underlying database

  displayName

String

Not currently supported; for future use

  estimatedSize

Integer

Estimated size in bytes; used to assist framework in managing databases

  replace

Boolean

If true, will replace the existing database if it exists; defaults to false

onSuccess

Function

Callback function that is called if the depot is successfully opened or created

onFailure

Function

Callback function that is called with an error string if an error occurs

add(key, objectToStore, 
onSuccess, onFailure)

Function to add an object, objectToStore, identified by a key

get(key, onSuccess, 
onFailure)

Gets the object identified by the key and returned as the single argument to the onSuccess function

discard(key, onSuccess, 
onFailure)

Removes the depot object associated with the key

removeAll(onSuccess, 
onFailure)

username

String

Login credentials

domain

String

The account source

accountId

String

The account reference for use in the Synergy applications

icons

Object

Includes largeIcon and smallIcon properties whose values are file paths to the appropriate account icons

dataTypes

Object

A hash of strings indicating which applications apply to this account, either "CONTACTS" or "CALENDAR"

isDataReadOnly

Boolean

If true, data with this account is read-only

calendarId

String

Immutable unique identifier for this calendar

name

String

Display name for this calendar

externalId

String

External ID for this calendar

subject

String

Title of the event

startTimestamp

String

Event start time (in milliseconds UTC)

endTimestamp

String

Event end time (in milliseconds UTC)

allDay

Boolean

True if all-day event

note

String

Optional note text

location

String

Location of the event

alarm

String

ISO 8601 duration format or none, all lowercase

rrule

String

RFC 2445 recurrence string, may only include RRULE, EXRULE, RDATE, or EXDATE

rruleTZ

String

rrule timezone object; this object is mandatory if an rrule is specified

endValidity

String

The end timestamp for nonrecurring events; for recurring events, the end timestamp of last occurrence or 0 if it repeats forever

attendees

Object

Event start time (in milliseconds UTC)

externalId

String

An externalId reference to this event and parented

parentId

String

This is an exception that needs to be linked to a parent recurring series

originalStartTimestamp

Integer

The original start timestamp of this event in the parent series

id

String

Immutable unique identifier for this Contact record

firstName

String

lastName

String

middleName

String

displayText

String

prefix

String

suffix

String

companyName

String

jobTitle

String

pictureLoc

String

File path to picture location; 50 × 50 pixels rough size

pictureLocSquare

String

File path to picture location; 50 × 50 pixels rough size, but guaranteed to be square

pictureLocBig

String

File path to picture location; a full size image

isAvatarLoc

String

The original start timestamp of this event in the parent series

birthday

String

YYYYMMDD format

anniversary

String

YYYYMMDD format

nickname

String

spouse

String

children

String

notes

String

phoneNumbers

Array

Array of phone number strings

emailAddresses

Array

Array of email address strings

imNames

Array

Array of IM names strings

addresses

Array

Array of physical address strings

urls

Array

Array of urls strings

customFields

Array

Array of custom field strings

listPic

String

Input only; the local file path of the picture to use as this contact’s photo in lists; should be square, roughly 50 × 50 pixels

incomingPic

String

Input only; the local file path of the picture to use as this contact’s high-quality photo

extraDetails

String

Generic overflow field for any metadata the third-party application wants to store (will not be displayed in the Contacts application)