Child pages
  • JSTable

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary

...

Table Cell (td)
JSColumn

...

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'
Divcache
styleindexdisplay:none

...

iddescription

...

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns a JSColumn for the named column (or column dataproviderID).

...

Table Cell (td)
String[]

...

Returns an array containing the names of all table columns.

...

Table Cell (td)
String

...

Returns the table data source uri.

...

Table Cell (td)
String

...

...

Returns a quoted version of the table name, if necessary, as defined by the actual database used.

...

Table Cell (td)
String[]
Returns an array containing the names of the identifier (PK) column(s).

...

Table Cell (td)
String

...

Returns the table name.

...

Table Cell (td)
String

...

Returns the Servoy server name.

...

Table Cell (td)
Boolean

...

id
HTML Table
Returns whether table was flagged as metadata table.

...

servoy sDetail

function

class
Colgroup Tag
Column
padding0px
width100%
Table Row (tr)
style
Table Row (tr)
idname
Table Cell (td)
getColumn
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSColumn
Span
stylefont-weight: bold;
getColumn
Span2100%height:30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetColumn-String
id2Methods DetailsgetColumnname

getColumn(name)

Table Row (tr)des Table Cell (td) DivclasssIndent
Returns a JSColumn for the named column (or column dataproviderID).
Table Row (tr)idtd
prsclass

Parameters

DivsIndent{String} name The name of the column to return the value from. Table Row (tr)idret

Table Cell (td)

Returns

DivclassJSColumnsIndentid JSColumn column.clients

Table Row (tr)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Table Cell (td) Table Row (tr)

classlastDetailRow
Table Cell (td) Table Body (tbody)
idgetColumnNames
Table Row (tr)
idname
Table Cell (td)
getColumnNames
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getColumnNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an array containing the names of all table columns.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String[] – String array of column names.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var columnNames = jsTable.getColumnNames()
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idgetDataSource
Table Row (tr)
idname
Table Cell (td)
getDataSource
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDataSource
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the table data source uri.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String – String datasource uri.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var dataSource = jsTable.getDataSource()
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idgetQuotedSQLName
Table Row (tr)
idname
Table Cell (td)
getQuotedSQLName
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getQuotedSQLName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a quoted version of the table name, if necessary, as defined by the actual database used.
Table Row (tr)
idret
Table Cell (td)Returns
Div
classsIndent
String – String

Sample

Div
classsIndent
Code Block
languagejavascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var jsColumn = jsTable.getColumn('campaign_name')
idsIdentjavascriptlastDetailRowgetColumnNamesname

getColumnNames()

dessIndent
Returns an array containing the names of all table columns.
If the table is in mem, then the internal rowid column name is not returned.
ret

Returns

sIndent String array of column names.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataSourcename

getDataSource()

dessIndent
Returns the table data source uri.
ret

Returns

sIndent String datasource uri.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getQuotedSQLNamename

getQuotedSQLName()

dessIndent
Returns a quoted version of the table name, if necessary, as defined by the actual database used.
ret

Returns

sIndent String table name, quoted if needed.
clients

Table Row (tr)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Table Cell (td) Table Row (tr)

classlastDetailRow
Table Cell (td) Table Body (tbody)
idgetRowIdentifierColumnNames
Table Row (tr)
idname
Table Cell (td)
getRowIdentifierColumnNames
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getRowIdentifierColumnNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an array containing the names of the identifier (PK) column(s).
Table Row (tr)
idret
Table Cell (td)Returns
Div
classsIndent
String[] – String

Sample

Div
classsIndent
Code Block
languagejavascript

//use with the raw SQL plugin:
//if the table name contains characters that are illegal in sql, the table name will be quoted
var jsTable = databaseManager.getTable('udm', 'campaigns')
var quotedTableName = jsTable.getQuotedSQLName()
plugins.rawSQL.executeSQL('udm',  quotedTableName,  'select * from ' + quotedTableName + ' where is_active = ?', [1])
Table Row (tr)
idname
Table Cell (td)
isMetadataTable
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
isMetadataTable
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns whether table was flagged as metadata table.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean – boolean is metadata
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var isMetaDataTable = jsTable.isMetadataTable()
Table Row (tr)
classlastDetailRow
tdsIdentjavascriptlastDetailRowgetRowIdentifierColumnNamesname

getRowIdentifierColumnNames()

dessIndent
Returns an array containing the names of the identifier (PK) column(s).
 Please note that if the table is in mem, then the internal rowid column name is also returned.
ret

Returns

sIndent String array of row identifier column names.
clients

Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var identifierColumnNames = jsTable.getRowIdentifierColumnNames()
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idgetSQLName
Table Row (tr)
idname
Table Cell (td)
getSQLName
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getSQLName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the table name.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String – String table name.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var tableNameForDisplay = jsTable.getSQLName()
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idgetServerName
Table Row (tr)
idname
Table Cell (td)
getServerName
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getServerName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the Servoy server name.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String – String server name.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var serverName = jsTable.getServerName()
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idisMetadataTable

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSQLNamename

getSQLName()

dessIndent
Returns the table name.
ret

Returns

sIndent String table name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getServerNamename

getServerName()

dessIndent
Returns the Servoy server name.
ret

Returns

sIndent String server name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isMetadataTablename

isMetadataTable()

dessIndent
Returns whether table was flagged as metadata table.
ret

Returns

sIndent boolean is metadata
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow