window.js

Summary

window.js
Window
Events
OnStartModal	Occurs when modal window curtain is going to be displayed.
OnStopModal	Occurs when modal window curtain is going to be removed.
ngStartModalControl	Shows modal window curtain.
ngStopModalControl	Hides modal window curtain.
ngCreateWindow	Creates window by definition.
ngWindow	This class implements a generic window control.
Definition
CW	ClientRect width.
CH	ClientRect height.
ParentReferences	...
ControlsPanel	Controls panel definition.
Properties
Text	...
HTMLEncode	...
BackgroundColor	...
Sizeable	...
Moveable	...
Modal	...
DisposeOnClose	...
AutoSize	...
Centered	...
MinimizedBounds	...
MinWidth	...
MinHeight	...
MaxWidth	...
MaxHeight	...
Buttons	...
Img	...
Frame	...
CaptionImg	...
Methods
Show	Makes a window visible.
Hide	Makes a window invisible.
Close	Closes the window.
Minimize	Shrinks the window.
Maximize	Expands the window to its maximal size.
Restore	Restores a window to its normal size.
Center	Centers the window.
CalcAutoSize	Calculates automatic window dimensions.
GetClientRect	Gets client rectangle dimensions.
SetClientRect	Sets client rectangle dimensions.
IsMaximized	Determines if window is maximized.
IsMinimized	Determines if window is miminized.
SetText	Sets window caption.
GetText	Gets window caption.
GetImg	Gets image.
Events
OnGetText
OnGetImg
OnClick
OnDblClick
OnMinimize
OnMaximize
OnRestore
OnClose
OnMouseMoving
OnMouseMove
OnMouseResizing
OnMouseResize
ngCreateHint	Creates hint by definition.
ngPopupHint	Creates hint by definition.
ngPopupCtrlHint	Creates hint by definition.
ngHint	This class implements a generic hint control.
Definition
CW	ClientRect width.
CH	ClientRect height.
ControlsPanel	Controls panel definition.
Properties
AutoSize	...
MinWidth	...
MinHeight	...
MaxWidth	...
MaxHeight	...
Anchor	...
Anchors	...
PreferredAnchors	...
Frame	...
ControlsInside	...
AutoHideTimeout	Defines the timeout in milliseconds when hint automatically hides itself (0=disabled).
DisposeOnHide	...
PopupX	Horizontal popup position in pixels.
PopupY	Vertical popup position in pixels.
PopupElm	Element to which hint was aligned during popup.
Methods
Popup	Popups hint at specified position.
PopupCtrl	Popups hint along specified control.
GetClientRect	Gets client rectangle dimensions.
SetClientRect	Sets client rectangle dimensions.
CalcAutoSize	Calculates automatic window dimensions.
BorderCollision	Calculates the border overflow of popup.
BoundRectCollision	Calculates the collision of popup and given boundary rectangle.
Events
OnCheckPlacement
OnPopup
ngCreateTextHint	Creates hint by definition.
ngPopupTextHint	Creates hint by definition.
ngPopupCtrlTextHint	Creates hint by definition.
ngTextHint	Simple hint text component (based on ngHint).
Definition
ParentReferences	...
Methods
SetText	Sets hint text.
GetText	Gets hint text.
Events
OnClick
OnSetText
OnGetText
Controls
Hint	ngText

Window

Events

OnStartModal

Occurs when modal window curtain is going to be displayed.

Syntax

bool OnStartModal ()

Returns

FALSE if curtain shouldn’t be displayed.

OnStopModal

Occurs when modal window curtain is going to be removed.

Syntax

bool OnStopModal ()

Returns

FALSE if curtain shouldn’t be removed.

ngStartModalControl

function ngStartModalControl()

Shows modal window curtain.

Syntax

void ngStartModalControl ()

Returns

ngStopModalControl

function ngStopModalControl()

Hides modal window curtain.

Syntax

void ngStopModalControl ()

Returns

ngCreateWindow

function ngCreateWindow( def,
parent )

Creates window by definition.

Syntax

object ngCreateWindow (object def, object parent)

Returns

Created window object (ngWindow).

ngWindow

This class implements a generic window control.

Syntax

new ngWindow ([string id])

Parameters

id	parent element

Definition

CW

ClientRect width. Type: integer

CH

ClientRect height. Type: integer

ParentReferences

... Type: bool Default value: false

ControlsPanel

Controls panel definition. Type: object

Properties

Text

this.Text

... Type: string

HTMLEncode

this.HTMLEncode

... Type: bool Default value: false

BackgroundColor

this.BackgroundColor

... Type: string

Sizeable

this.Sizeable

... Type: bool Default value: true

Moveable

this.Moveable

... Type: bool Default value: true

Modal

this.Modal

... Type: bool Default value: false

DisposeOnClose

this.DisposeOnClose

... Type: bool Default value: false

AutoSize

this.AutoSize

... Type: bool Default value: true

Centered

this.Centered

... Type: bool Default value: false

MinimizedBounds

... Type: object Default value: undefined

MinWidth

this.MinWidth

... Type: int Default value: 100

MinHeight

this.MinHeight

... Type: int Default value: 100

MaxWidth

this.MaxWidth

... Type: int Default value: 0

MaxHeight

this.MaxHeight

... Type: int Default value: 0

Buttons

this.Buttons

... Type: object

Img

this.Img

... Type: object

Frame

this.Frame

... Type: object

CaptionImg

this.CaptionImg

... Type: object

Methods

Show

Makes a window visible.

Syntax

void Show ()

Parameters

Returns

Hide

Makes a window invisible.

Syntax

void Hide ()

Parameters

Returns

Close

Closes the window.

Syntax

void Close ()

Parameters

Returns

Minimize

Shrinks the window.

Syntax

void Minimize ()

Parameters

Returns

Maximize

Expands the window to its maximal size.

Syntax

void Maximize ()

Parameters

Returns

Restore

Restores a window to its normal size.

Syntax

void Restore ()

Parameters

Returns

Center

Centers the window.

Syntax

void Restore ()

Parameters

Returns

CalcAutoSize

Calculates automatic window dimensions.

Syntax

void CalcAutoSize ()

Parameters

Returns

GetClientRect

Gets client rectangle dimensions.

Syntax

object GetClientRect ()

Returns

Rectangle dimensions in format { W: width, H: height }.

SetClientRect

Sets client rectangle dimensions.

Syntax

void SetClientRect (object rect)

Parameters

rect	{ W: width, H: height } Returns: -

IsMaximized

Determines if window is maximized.

Syntax

bool IsMaximized ()

Parameters

Returns

IsMinimized

Determines if window is miminized.

Syntax

bool IsMinimized ()

Parameters

Returns

SetText

Sets window caption.

Syntax

void SetText (string text)

Parameters

Returns

GetText

Gets window caption.

Syntax

string GetText (void)

Returns

Window caption.

GetImg

Gets image.

Syntax

object GetImg (void)

Returns

The image.

Events

OnGetText

OnGetImg

OnClick

OnDblClick

OnMinimize

OnMaximize

OnRestore

OnClose

OnMouseMoving

OnMouseMove

OnMouseResizing

OnMouseResize

ngCreateHint

function ngCreateHint( def,
parent )

Creates hint by definition.

Syntax

object ngCreateHint (object def, object parent)

Returns

Created hint object (ngHint).

ngPopupHint

function ngPopupHint( def,
x,
y,
anchor,
parent )

Creates hint by definition.

Syntax

object ngPopupHint (object def, int x, int y, string anchor, object parent)

Returns

Created hint object (ngHint).

ngPopupCtrlHint

function ngPopupCtrlHint( def,
ctrl,
anchor,
parent )

Creates hint by definition.

Syntax

object ngPopupCtrlHint (object def, object ctrl, string anchor, object parent)

Returns

Created hint object (ngHint).

ngHint

This class implements a generic hint control.

Syntax

new ngHint ([string id])

Parameters

id	parent element

Definition

CW

ClientRect width. Type: integer

CH

ClientRect height. Type: integer

ControlsPanel

Controls panel definition. Type: object

Properties

AutoSize

this.AutoSize

... Type: bool Default value: true

MinWidth

this.MinWidth

... Type: int Default value: 0

MinHeight

this.MinHeight

... Type: int Default value: 0

MaxWidth

this.MaxWidth

... Type: int Default value: 0

MaxHeight

this.MaxHeight

... Type: int Default value: 0

Anchor

this.Anchor

... Type: string Default value: ’auto’

Anchors

this.Anchors

... Type: object

PreferredAnchors

... Type: array

Frame

this.Frame

... Type: object

ControlsInside

this.ControlsInside

... Type: bool Default value: true

AutoHideTimeout

Defines the timeout in milliseconds when hint automatically hides itself (0=disabled). Type: integer Default value: 0

DisposeOnHide

this.DisposeOnHide

... Type: bool Default value: false

PopupX

Horizontal popup position in pixels. Type: integer Default value: undefined

PopupY

Vertical popup position in pixels. Type: integer Default value: undefined

PopupElm

Element to which hint was aligned during popup. Type: integer Default value: undefined

Methods

Popup

Popups hint at specified position.

Syntax

void Popup (integer x, integer y [, string anchor])

Returns

PopupCtrl

Popups hint along specified control.

Syntax

void PopupCtrl (object ctrl [, string anchor])

Returns

GetClientRect

Gets client rectangle dimensions.

Syntax

object GetClientRect ()

Returns

Rectangle dimensions in format { W: width, H: height }.

SetClientRect

Sets client rectangle dimensions.

Syntax

void SetClientRect (object rect)

Parameters

rect	{ W: width, H: height } Returns: -

CalcAutoSize

Calculates automatic window dimensions.

Syntax

void CalcAutoSize ()

Parameters

Returns

BorderCollision

Calculates the border overflow of popup. Helper function for placement calculation.

Syntax

int BorderCollision (object placement, int left, int top, int right, int bottom)

Parameters

Returns

Affected area.

BoundRectCollision

Calculates the collision of popup and given boundary rectangle. Helper function for placement calculation.

Syntax

int BoundRectCollision (object placement, int left, int top, int right, int bottom)

Parameters

Returns

Affected area.

Events

OnCheckPlacement

OnPopup

ngCreateTextHint

function ngCreateTextHint( def,
text,
parent )

Creates hint by definition.

Syntax

object ngCreateTextHint (object def, string text, object parent)

Returns

Created hint object (ngHint).

ngPopupTextHint

function ngPopupTextHint( def,
x,
y,
text,
anchor,
parent )

Creates hint by definition.

Syntax

object ngPopupTextHint (object def, int x, int y, string text, string anchor, object parent)

Returns

Created hint object (ngHint).

ngPopupCtrlTextHint

function ngPopupCtrlTextHint( def,
ctrl,
text,
anchor,
parent )

Creates hint by definition.

Syntax

object ngPopupCtrlTextHint (object def, object ctrl, string text, string anchor, object parent)

Returns

Created hint object (ngHint).

ngTextHint

Simple hint text component (based on ngHint).

Summary

Definition
ParentReferences	...
Methods
SetText	Sets hint text.
GetText	Gets hint text.
Events
OnClick
OnSetText
OnGetText
Controls
Hint	ngText

window.js

Window

Events

OnStartModal

Syntax

Returns

OnStopModal

Syntax

Returns

ngStartModalControl

Syntax

Returns

ngStopModalControl

Syntax

Returns

ngCreateWindow

Syntax

Returns

ngWindow

Syntax

Parameters

See also

Definition

CW

CH

ParentReferences

ControlsPanel

Properties

Text

HTMLEncode

BackgroundColor

Sizeable

Moveable

Modal

DisposeOnClose

AutoSize

Centered

MinimizedBounds

MinWidth

MinHeight

MaxWidth

MaxHeight

Buttons

Img

Frame

CaptionImg

Methods

Show

Syntax

Parameters

Returns

Hide

Syntax

Parameters

Returns

Close

Syntax

Parameters

Returns

Minimize

Syntax

Parameters

Returns

Maximize

Syntax

Parameters

Returns

Restore

Syntax

Parameters

Returns

Center

Syntax

Parameters

Returns

CalcAutoSize

Syntax

Parameters

Returns

GetClientRect