The PopUp is a special window component used by Overlays it will open a full customizable window using the widgets system.

How to Initialize any PopUp?


PopUp has to be called by a Overlays with the function AddPopUp.

Also call SetOpening to setup the animation details, the PopUp will not open without this function.

Class Details

Functions:


       Initialization & Main Functions

Name

Arguments

Return

Description

Init
  • String: BaseID - HMTL ID defining the position in the DOM of the popup.
  • String: RegistryName - Name that define this popup, all children IDs will start by this.

VOID

This function Initialized every part of the viewer: HMTL, CSS, Data, Events, etc...

It will be generated in the defined ID and all HTML IDs used for this  will start by the RegistryName defined in arguments.

Launch
  • None

VOID

Launch all systems required by the this and will call all children launch.

SetOpening
  • Curves: CurveType - opening animation curve type.
  • Integer: Duration - Opening time.
  • Integer: FPS - Opening frame rate
  • Class: CurveDetails - Details required by some curves.

VOID

Will set all details about the opening animation.

Open
  • None

VOID

Open the popup

Close
  • None

VOID

Close the popup



Setters Functions


Name

Arguments

Return

Description

SetSizePosition
  • Integer - @CSS String: Width - of this widget (based  on parent).
  • Integer - @CSS String: Height - of this widget (based  on parent).
  • Integer - @CSS String: X - (horizontal) of this widget (based  on parent).
  • Integer - @CSS String: Y - (vertical) of this widget (based  on parent).
  • Boolean: FromRight - Set if x has to start from right
  • Boolean: FromBottom - Set if x has to start from bottom

This

Set the size and the position of this popup.

SetBackgroundColor
  • Color: Color - Background Color

This

Will change the popup background color

SetBorder
  • @CSS String: Type - CSS border type.
  • Integer - @CSS String: Thickness - CSS border size.
  • Color: Color - Border Color
  • Integer - @CSS String - Class: Thickness - Set the border radius (integer will be same "px" for all). To use the class just send member like: class.top_left.

This

Add a border to the popup

SetBackColor
  • Color: Color - Back color

This

Set the color of behind the popup (Used to hide app will the popup is active).

AddWidget
  • WidgetType: Type - Define which widget you want.
  • String: Name - Name of this widgets.

Widgets

Add a widget inside the popup.




Private Details


All private details are usable but its recommended to not use any of those. It might modify the proper functioning of the class.


Variables (Members):


       Main Members

Name

Type

Default Value

Description

id

String

undefined

Global HMTL Id of the viewer (# + name).

registryName

String

undefined

Name of this widget.

basedId

String

undefined

Where it is located is the existing DOM (its parent).


Information

Name

Type

Default Value

Description

position

Class

x: 0 and y: 0 and fromRight: false and fromBottom: false

Hold the actual position of the widget.

scale

Integer

0

Hold what is this actual scale of the popup (for animations).

animation

Integer

null

Actual animation ID.

curve

Class

{}

Hold curves details, set by SetOpening function.

AllWidget

Widgets[]

[]

Hold all children Widgets.

lastZIndex

Integer

100

To make sure the Widgets are properly layered we decrement this variable each widgets.


Functions:        

Interaction Functions

Name

Arguments

Return

Description

GetContent
  • None

JQuery DOM Object

Return the content JQuery DOM Object

GetBack
  • None

JQuery DOM Object

Return the back JQuery DOM Object



Compatibility


LANGUAGE CLASS: Not compatible.

Created with the Personal Edition of HelpNDoc: Free Web Help generator