Reusable Accessible Mapping Platform

API Docs for: 2.0.0
Show:

SubPanel Class

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

[subPanelPrototype description]

Constructor

SubPanel

()

Defined in src\js\RAMP\Modules\gui.js:234

Methods

changeOrigin

(
  • newOrigin
)

Defined in src\js\RAMP\Modules\gui.js:482

Assigns a new origin to the SubPanel.

Parameters:

  • newOrigin String

    The new origin of the SubPanel.

create

(
  • a
)

Defined in src\js\RAMP\Modules\gui.js:507

Creates a new instance of SubPanel.

Parameters:

destroy

(
  • speed
  • deferred
)

Defined in src\js\RAMP\Modules\gui.js:405

Destroys this SubPanel.

Parameters:

  • speed Number

    The duration of the animation in milliseconds

  • deferred Deferred

    The deferred to be resolved after the SubPanel is destroyed

getAttributes

() SubPanelSettings

Defined in src\js\RAMP\Modules\gui.js:360

Returns this SubPanel's settings object.

Returns:

SubPanelSettings:

This SubPanel's settings

getContainer

() Jobject

Defined in src\js\RAMP\Modules\gui.js:369

Returns this SubPanel's container div.

Returns:

Jobject:

This SubPanel's div

getOrigin

() String

Defined in src\js\RAMP\Modules\gui.js:387

Returns the origin of this SubPanel.

Returns:

String:

The origin of this SubPanel

getOrigin

() String

Defined in src\js\RAMP\Modules\gui.js:396

Returns the guid of this SubPanel.

Returns:

String:

The guid of this SubPanel

getPanel

() JObject

Defined in src\js\RAMP\Modules\gui.js:378

Returns the inner div of the SubPanel

Returns:

JObject:

The inner div of the SubPanel

getPanelWidthDefault

() Number private

Defined in src\js\RAMP\Modules\gui.js:781

Return the default width of the SidePanel.

Returns:

Number:

The default width of the SidePanel

layoutChange

() private

Defined in src\js\RAMP\Modules\gui.js:753

Fires an event when the layout of the page changes.

open

()

Defined in src\js\RAMP\Modules\gui.js:467

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

parseContent

(
  • data
)
JObject

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

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 src\js\RAMP\Modules\gui.js:450

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

shiftTarget

(
  • newTarget
)

Defined in src\js\RAMP\Modules\gui.js:492

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 src\js\RAMP\Modules\gui.js:573

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 src\js\RAMP\Modules\gui.js:332

Default duration of the SubPanel animation in milliseconds.

Default: 0.5

_attr

SubPanelSettings private

Defined in src\js\RAMP\Modules\gui.js:263

SubPanel attributes

Default: null

_closing

Boolean private

Defined in src\js\RAMP\Modules\gui.js:242

Indicates if the closing animation is under way.

Default: false

_destroyDeferred

Deferred private

Defined in src\js\RAMP\Modules\gui.js:253

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

Default: null

_panelContentDiv

JObject private

Defined in src\js\RAMP\Modules\gui.js:322

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

Default: null

_panelTitle

JObject private

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

Heading of the content in the SubPanel.

Default: null

_subPanelContentDiv

JObject private

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

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

Default: null

_visible

Boolean private

Defined in src\js\RAMP\Modules\gui.js:273

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 src\js\RAMP\Modules\gui.js:284

The outermost div of the SubPanel.

Default: null

panel

JQobject

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

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

Default: null