JavaScript component side

JavaScript classes that can be used on component side. More...

Category Description

JavaScript classes that can be used on component side.

This module describes the global methods and classes that are accessible for Rogue Wave Server/Rogue Wave Views integration. It is meant as a supplement to the Views Script for Rogue Wave Views documentation (Data Access package) and assumes that you are familiar with the Views Script environment within Rogue Wave Views.

Most of the global methods and classes described in this chapter reference Rogue Wave Server/Rogue Wave Views component objects, in which case they can only be used in the Views component and not in Rogue Wave Server Studio. Global functions that reference standard Rogue Wave Views objects can be used both with the Views component and Server Studio.

Keep in mind that:

• Normally, Views Script is used in the Server Studio environment, but a class or method that works only in the Views component cannot be tested in the Studio test mode.
• In the Views Script for Rogue Wave Server/Rogue Wave Views mapping, all column and row numbers start from zero.

When applicable, you can also refer to the corresponding class from the C++ library for more information. The server-side Views Script classes are described in JavaScript server side module.

Warning

These classes are not C++ classes. The javascript namespace is a documentation convention to describe the Server JavaScript API.

Classes
class	javascript::IlsMvComponent
	IlsMvComponent JavaScript proxy. More...
class	javascript::IlsRepresentation
	Implements the representations associated with each dynamic view in the server. More...
class	javascript::IlsRpObject
	The base class for any representation object. More...
class	javascript::IlsSwRow
	IlsSwRow JavaScript proxy. More...
class	javascript::IlsSwServerDataSource
	IlsSwServerDataSource JavaScript proxy. More...
class	javascript::IlsSwTable
	IlsSwTable JavaScript proxy. More...

Functions
IlvSwMemoryDataSource	javascript::IlsSwGetNamedDs (String name, IlvContainer cont)
	Returns the named data source in the panel. More...
IlsRepresentation	javascript::IlsSwGetRepresentation (IlvGraphic graphic)
	Returns the representation, if any, associated with the graphic. More...
IlsRepresentation	javascript::IlsSwGetRepresentationFromDs (IlvSwMemoryDataSource ds)
	Returns the representation, if any, associated with the data source. More...
IlsSwRow	javascript::IlsSwGetRow (IlvGraphic graphic, Int rowno=current)
	Returns the row, if any, associated with the graphic. More...
IlsSwRow	javascript::IlsSwGetRowFromDs (IlvSwMemoryDataSource ds, Int rowno=current)
	returns the row, if any, associated with the data source. More...
IlsSwTable	javascript::IlsSwGetTable (IlvGraphic graphic)
	Returns the table associated with the graphic if any. More...
IlsSwTable	javascript::IlsSwGetTableFromDs (IlvSwMemoryDataSource ds)
	Returns the table, if any, associated with the data source. More...

Function Documentation

IlsSwGetNamedDs()

IlvSwMemoryDataSource javascript::IlsSwGetNamedDs	(	String	name,
		IlvContainer	cont
	)

Returns the named data source in the panel.

This function replaces the standard Rogue Wave Views mechanism used to find a data source in a panel, because Server-created data sources are not inserted in the pane and so cannot be retrieved via a call to getObject on the panel.

Warning

This function is a JavaScript function, not a C++ one.

See also

IlsSwServerDataSource (JavaScript).

Parameters

name	data source name
cont	container

Returns

the named data source in the panel.

IlsSwGetRepresentation()

IlsRepresentation javascript::IlsSwGetRepresentation

(

IlvGraphic

graphic

)

Returns the representation, if any, associated with the graphic.

Example

var rep = IlsSwGetRepresentation(obj);

Warning

This function is a JavaScript function, not a C++ one.

See also

IlsSwGetRepresentationFromDs (JavaScript), IlsRepresentation (JavaScript), IlsRepresentation (C++).

Parameters

graphic

graphic the representation is associated with.

Returns

the representation, if any, associated with the graphic.

IlsSwGetRepresentationFromDs()

IlsRepresentation javascript::IlsSwGetRepresentationFromDs

(

IlvSwMemoryDataSource

ds

)

Returns the representation, if any, associated with the data source.

Warning

This function is a JavaScript function, not a C++ one.

See also

IlsSwGetRepresentation (JavaScript), IlsRepresentation (JavaScript).

Parameters

ds	data source the representation is associated with.

Returns

the representation, if any, associated with the data source.

IlsSwGetRow()

IlsSwRow javascript::IlsSwGetRow	(	IlvGraphic	graphic,
		Int	rowno = current
	)

Returns the row, if any, associated with the graphic.

In the Views Script mapping, row numbers start from zero.

Example

var currentRow = IlsSwGetRow(obj);
var firstRow = IlsSwGetRow(obj, 0);

Warning

This function is a JavaScript function, not a C++ one.

See also

IlsSwGetRowFromDs (JavaScript), IlsSwRow (JavaScript).

Parameters

graphic	graphic the row is associated with
rowno	[optional] If it is not provided, the current row is returned.

Returns

the row, if any, associated with the graphic. returns null if the graphic is not a field itf (data-source aware) gadget or is not attached to a Server data source.

IlsSwGetRowFromDs()

IlsSwRow javascript::IlsSwGetRowFromDs	(	IlvSwMemoryDataSource	ds,
		Int	rowno = current
	)

returns the row, if any, associated with the data source.

In the Rogue Wave Views Script mapping, row numbers start from zero.

Example

var ds = ...;
var currentRow = IlsSwGetRowFromDs(ds);
var firstRow = IlsSwGetRowFromDs(ds, 0);

Warning

This function is a JavaScript function, not a C++ one.

See also

IlsSwGetRow (JavaScript), IlsSwRow (JavaScript).

Parameters

ds	the data source the row is associated with.
rowno	[optional] If the row number is not provided, the current row is returned.

Returns

the row, if any, associated with the data source. Returns null if the data source is not a Server data source.

IlsSwGetTable()

IlsSwTable javascript::IlsSwGetTable

(

IlvGraphic

graphic

)

Returns the table associated with the graphic if any.

Example

var table = IlsSwGetTable(obj);

Warning

This function is a JavaScript function, not a C++ one.

See also

IlsSwGetTableFromDs (JavaScript).

Parameters

graphic

the graphic the table is associated with.

Returns

the table associated with the graphic if any. It returns null if the graphic is not a field itf data source aware gadget or is not attached to a Server data source.

IlsSwGetTableFromDs()

IlsSwTable javascript::IlsSwGetTableFromDs

(

IlvSwMemoryDataSource

ds

)

Returns the table, if any, associated with the data source.

Warning

This function is a JavaScript function, not a C++ one.

See also

IlsSwGetTable (JavaScript).

Parameters

ds	the data source the table is associated with.

Returns

the table, if any, associated with the data source. It returns null if the data source is not a Server data source.