APIs

Show:

This static object was used to control all of the popups active in the app. Some method should still be used (error, message, confirm) but for controlling individual popups, please access them directly as view objects;

Methods

ajaxError

(
  • jqXHR
  • textStatus
)
Undefined

Report a HTTP request error.

Parameters:

  • jqXHR JqXHR

    XHR Object

  • textStatus String

    Readable status

Returns:

Undefined:

close

(
  • id
)
Undefined deprecated

Parameters:

  • id String

    The popup's

    id

Returns:

Undefined:

close_dynamic

(
  • identifier
)
Undefined deprecated

Parameters:

  • identifier String

    The popup's identifier

Returns:

Undefined:

confirm

(
  • message
  • confirm
  • cancel
  • options
)
Undefined

Parameters:

  • message String

    The message to display

  • confirm Function

    Function to call if the user selects Yes

  • cancel Function

    Function to call if the user selects No

  • options Object

    Various other parameters

Returns:

Undefined:

error

(
  • message
  • options
)
Undefined

Parameters:

  • message String

    The message to display

  • options Obejct

    Various options

Returns:

Undefined:

error

(
  • message
  • options
)
Undefined

Parameters:

  • message String

    The message to display

  • options Obejct

    Various options

Returns:

Undefined:

error_report

(
  • message
  • callback,
)
Undefined

Parameters:

  • message String

    The message to display

  • callback, Function

    Function to call if the user chooses the report option. you will be passed in the optional user message.

Returns:

Undefined:

insert_overlay

(
  • id
)
Undefined

Parameters:

  • id String

    The

    id of the popup or an id for the overlay

Returns:

Undefined:

is_open

(
  • identifier
)
Boolean

Parameters:

  • identifier String

    The popup's identifier

Returns:

Boolean:

true or false

message

(
  • message
  • [options]
)
Undefined

Parameters:

  • message String

    The message to display

  • [options] Object optional

    Various options

    • [isError] Boolean optional

      Indicates popup should be an error

    • [isWarning] Boolean optional

      Indicates popup should be a warning

    • [title] String optional

      Text placed in title of popup

    • [identifier] String optional

      Identifier assigned to popup dom element

Returns:

Undefined:

readonly

() Undefined

Display a read only mode warning message.

Returns:

Undefined:

remove_overlay

(
  • id
)
Undefined

Parameters:

  • id String

    The id of the overlay passed into popup.insert_overlay()

Returns:

Undefined:

reposition

(
  • identifier
)
Undefined deprecated

Parameters:

  • identifier String

    The popup's identifier

Returns:

Undefined:

restore_draggable

(
  • id
)
Undefined deprecated

Parameters:

  • id String

    The popup

    id

Returns:

Undefined:

text_prompt

(
  • callback
  • message
)
Undefined

Parameters:

  • callback Function

    Function to call if the user selects Yes

  • message String

    The message to display

Returns:

Undefined:

three_button

(
  • message
  • button1
  • button2
  • button3
)
Undefined

Parameters:

  • message String

    The message to display

  • button1 Object

    object with message and function for selection

  • button2 Object

    object with message and function for selection

  • button3 Object

    object with message and function for selection

Returns:

Undefined: