API Docs for: 0.0.8-0
Show:

SubPanel Class

Defined in: javascript\src\RAMP\Modules\gui.js:213
Module: UI
Parent Module: RAMP

[subPanelPrototype description]

Constructor

Methods

changeOrigin

(
  • newOrigin
)

Defined in javascript\src\RAMP\Modules\gui.js:460

Assigns a new origin to the SubPanel.

Parameters:

  • newOrigin String

    The new origin of the SubPanel.

create

(
  • a
)

Defined in javascript\src\RAMP\Modules\gui.js:485

Creates a new instance of SubPanel.

Parameters:

destroy

(
  • speed
  • deferred
)

Defined in javascript\src\RAMP\Modules\gui.js:372

Destroys this SubPanel.

Parameters:

  • speed Number

    The duration of the animation in milliseconds

  • deferred Deferred

    The deffered to be resolved after the SubPanel is destroyed

getAttributes

() SubPanelSettings

Defined in javascript\src\RAMP\Modules\gui.js:327

Returns this SubPanel's settings object.

Returns:

SubPanelSettings:

This SubPanel's settings

getContainer

() Jobject

Defined in javascript\src\RAMP\Modules\gui.js:336

Returns this SubPanel's container div.

Returns:

Jobject:

This SubPanel's div

getOrigin

() String

Defined in javascript\src\RAMP\Modules\gui.js:354

Returns the origin of this SubPanel.

Returns:

String:

The origin of this SubPanel

getOrigin

() String

Defined in javascript\src\RAMP\Modules\gui.js:363

Returns the guid of this SubPanel.

Returns:

String:

The guid of this SubPanel

getPanel

() JObject

Defined in javascript\src\RAMP\Modules\gui.js:345

Retursn the inner div of the SubPanel

Returns:

JObject:

The inner div of the SubPanel

open

()

Defined in javascript\src\RAMP\Modules\gui.js:435

Opens the SubPanel. Sends out EventManager.GUI.SUBPANEL_CHANGE event.

parseContent

(
  • data
)
JObject

Defined in javascript\src\RAMP\Modules\gui.js:312

Apply the shortening plugin to the panel data

Parameters:

  • data JObject

    Content to be shortened

Returns:

JObject:

Content with after shortening long text nodes

reopen

()

Defined in javascript\src\RAMP\Modules\gui.js:419

Reopens the SubPanel - stops the closing animation and initiates the opening animation.

shiftTarget

(
  • newTarget
)

Defined in javascript\src\RAMP\Modules\gui.js:470

Shifts the SubPanel to the new node in the DOM.

Parameters:

  • newTarget JObject

    A node in the DOM to shift the SubPanel to

update

(
  • a
)

Defined in javascript\src\RAMP\Modules\gui.js:519

Performs an update of the content and title of the SubPanel, running appropriate animation and doOn- / doAfter- functions.

Parameters:

Properties

_animatePanelDuration

Number private

Defined in javascript\src\RAMP\Modules\gui.js:302

Default duration of the SubPanel animation in milliseconds.

Default: 400

_attr

SubPanelSettings private

Defined in javascript\src\RAMP\Modules\gui.js:240

SubPanel attributes

Default: null

_closing

Boolean private

Defined in javascript\src\RAMP\Modules\gui.js:221

Indicates if the closing animation is under way.

Default: false

_destroyDeferred

Deferred private

Defined in javascript\src\RAMP\Modules\gui.js:231

Holds a deferred that would destory the panel after the closing animation completes. May be interrupted.

Default: null

_panelContentDiv

JObject private

Defined in javascript\src\RAMP\Modules\gui.js:293

div housing the content of the SubPanel, excluding its title.

Default: null

_panelTitle

JObject private

Defined in javascript\src\RAMP\Modules\gui.js:284

Heading of the content in the SubPanel.

Default: null

_subPanelContentDiv

JObject private

Defined in javascript\src\RAMP\Modules\gui.js:275

div housing the content of the SubPanel, including its title.

Default: null

_visible

Boolean private

Defined in javascript\src\RAMP\Modules\gui.js:249

Indicates if the SubPanel is visible at the moment. Doesn't make the panel visible or invisible, just prevents animations on the content to run when it is set to true.

Default: false

container

JObject

Defined in javascript\src\RAMP\Modules\gui.js:259

The outermost div of the SubPanel.

Default: null

footerDelta

Number private

Defined in javascript\src\RAMP\Modules\gui.js:651

Specifies the hight of the footer in the full-screen mode. Should be smaller than footerHeight.

fullScreenDelta2

Number private

Defined in javascript\src\RAMP\Modules\gui.js:665

The height difference between the normal and full-screen modes.

panel

JQobject

Defined in javascript\src\RAMP\Modules\gui.js:267

The inner div of the SubPanel. Closing and opening animations are run on this div.

Default: null