This is a classic loading bar, fully generated.

How to Initialize the Loading Bar?


The initialization of the Overlapping Tab is an one step process, just call the function Init of the class with its two arguments (see bellow for more details).



Class Details

Functions:


       Initialization & Main Functions

Name

Arguments

Return

Description

Init
  • String: BaseID - HMTL ID defining the position in the DOM of the tab
  • String: RegistryName - Define the name of the Bar all Bar components will be defined by this name (this is to avoid mixing if you use different Bar, so be sure to use different name for each Bar).

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 tab will start by the RegistryName defined in arguments

SetPercent
  • Integer: SetPercent - %

VOID

Set the bar percent status (It will update CSS).



Setters Functions


Name

Arguments

Return

Description

SetPositionAbsolute
  • None

VOID

Change CSS: Position to Absolute. Cancel SetPositionFixed().

SetPositionFixed
  • None

VOID

Change CSS: Position to Fixed. Cancel SetPositionAbsolute().

SetTop
  • @CSS String: CssSize - String for the size, using CSS size type

VOID

Set the top distance of the loading bar. It remove the Bottom property.

SetTopMiddle
  • None

VOID

Set the the loading bar position centered with the top property. It remove the Bottom property.

SetBottom
  • @CSS String: CssSize - String for the size, using CSS size type

VOID

Set the bottom distance of the loading bar. It remove the Top property.

SetBottomMiddle
  • None

VOID

Set the the loading bar position centered with the bottom property. It remove the top property.

SetLeft
  • @CSS String: CssSize - String for the size, using CSS size type

VOID

Set the left distance of the loading bar. It remove the Right property.

SetLeftMiddle
  • None

VOID

Set the the loading bar position centered with the left property. It remove the Right property.

SetRight
  • @CSS String: CssSize - String for the size, using CSS size type

VOID

Set the left distance of the loading bar. It remove the Left property.

SetRightMiddle
  • None

VOID

Set the the loading bar position centered with the Right property. It remove the Left property.

SetHeight
  • Integer: Size - The height size
  • String: Scale - The CSS unit you want to use.

VOID

Change the loading bar height.

SetWidth
  • Integer: Size - The height size
  • String: Scale - The CSS unit you want to use.

VOID

Change the loading bar width.

SetRounded
  • Boolean: IsRounded - If the loading bar have to be rounded on the edges.

VOID

Round up (or remove) the loading bar edges.

SetBackColor
  • @CSS String: Color - CSS Color

VOID

Change the color of the inactive part of the loading bar.

SetFontColor
  • @CSS String: Color - CSS Color

VOID

Change the color of the active part of the loading bar.





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

height

Integer

20

The value in Integer of the height.

heightType

String

"px"

The CSS Type of the height size.

width

Integer

200

The value in Integer of the width.

widthType

String

"px"

The CSS Type of the width size.

id

String

undefined

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

registryName

String

undefined

Name of this Loading Bar.



Functions:        

Util Functions

Name

Arguments

Return

Description

GetBackDivID
  • None

String

return the ID of the back div (the inactive bar).

GetFrontDivID
  • None

String

return the ID of the front div (the active bar).




Compatibility


LANGUAGE CLASS: Not compatible.

Created with the Personal Edition of HelpNDoc: Easily create HTML Help documents