GLG Toolkit, JavaScript Library  Version 4.6
GlgInteger Class Reference

Mutable integer object. More...

Detailed Description

Mutable integer object.

This object contains an integer value and is used to pass integer values as objects to the SendMessageToObject method.

GlgInteger instances can be created using CreateGlgInteger.

Static Public Member Functions

static GlgInteger CreateGlgInteger (int value)
 Constructor. More...
 
static int GetValue (GlgInteger object)
 Retrieves an integer value of GlgInteger. More...
 
static void ReleaseToCache (GlgInteger integer_obj)
 Returns the object to the internal cache for reuse. More...
 
static void SetValue (GlgInteger object, int value)
 Sets an integer value of GlgInteger. More...
 

Member Function Documentation

◆ CreateGlgInteger()

static GlgInteger CreateGlgInteger ( int  value)
static

Constructor.

Creates an instance of GlgInteger containing the specified value. The static method is invoked on the GLG Toolkit handle obtained via a 'new GlgToolkit()' call at the application start-up.

Parameters
valueThe value to assign to the GlgInteger instance.
Returns
A new instance of GlgInteger.

◆ GetValue()

static int GetValue ( GlgInteger  object)
static

Retrieves an integer value of GlgInteger.

The static method is invoked on the GLG Toolkit handle obtained via a 'new GlgToolkit()' call at the application start-up.

Parameters
objectThe object to query.
Returns
The object's value.

◆ ReleaseToCache()

static void ReleaseToCache ( GlgInteger  integer_obj)
static

Returns the object to the internal cache for reuse.

The object should not be accessed after it is released to the cache.

Only objects obtained with a call to GLG API method should be released to the cache.

The static method is invoked on the GLG Toolkit handle obtained via a 'new GlgToolkit()' call at the application start-up.

Parameters
integer_objThe object to release.

◆ SetValue()

static void SetValue ( GlgInteger  object,
int  value 
)
static

Sets an integer value of GlgInteger.

The static method is invoked on the GLG Toolkit handle obtained via a 'new GlgToolkit()' call at the application start-up.

Parameters
objectThe object to set the value of.
valueThe new value.