publish
plugins.it2be_htmleditor info


Servoy Properties Summary
String build
Date buildDate
String component
String licensee
String typeLicensed
Boolean useDefaultStyle
Number version
String versionLicensed


Servoy Methods Summary
void createFolderInRoot( String )
IHEditor editor( )
IHEditor getEditor( Object )
Array<Object> getEditors( )
void openFile( String, String )
void openFile( String, String, Boolean, Object )
void openFile( String, String, Boolean )
void openFile( String, String, Boolean, Object, Function )
void openFile( String )
void openFile( String, Boolean, Object )
void openFile( String, Boolean )
void openFile( String, Boolean, Object, Function )
void openStringSaveInFile( String, String )
void openStringSaveInFile( String, String, String )
void openStringSaveInFile( String, String, Boolean, Object )
void openStringSaveInFile( String, String, String, Boolean, Object, Function )
void openStringSaveInFile( String, String, String, Boolean )
void openStringSaveInFile( String, String, Boolean, Object, Function )
void openStringSaveInFile( String, String, String, Boolean, Object )
void openStringSaveInFile( String, String, Boolean )
void openStringSaveinTableColumn( String, String, String, String, String )
void openStringSaveinTableColumn( String, String, String, String, String, String, Boolean, Object, Function )
void openStringSaveinTableColumn( String, String, String, String, String, Boolean, Object, Function )
void openStringSaveinTableColumn( String, String, String, String, String, Boolean, Object )
void openStringSaveinTableColumn( String, String, String, String, String, String )
void openStringSaveinTableColumn( String, String, String, String, String, String, Boolean, Object )
void openStringSaveinTableColumn( String, String, String, String, String, Boolean )
void openStringSaveinTableColumn( String, String, String, String, String, String, Boolean )
void openTableColumn( String, String, String, String, Boolean, Object )
void openTableColumn( String, String, String, String, String )
void openTableColumn( String, String, String, String, Boolean, Object, Function )
void openTableColumn( String, String, String, String, String, Boolean, Object, Function )
void openTableColumn( String, String, String, String, String, Boolean )
void openTableColumn( String, String, String, String, String, Boolean, Object )
void openTableColumn( String, String, String, String, Boolean )
void openTableColumn( String, String, String, String )
Boolean register( String )
void setEditorModal( Boolean )
void setHeight( Number )
void setMediaFolder( String )
void setStyleSheet( String )
void setStyleSheet( String, Boolean, Boolean )
void setStyleSheet( String, Boolean )
void setWidth( Number )
void showEditor( )
void showEditor( String, String )
void showEditor( String )
void showEditor( String, Boolean, Object, Function )
void showEditor( String, String, Boolean, Object, Function )
void showEditor( String, Boolean )
void showEditor( String, Boolean, Object )
void showEditor( String, String, Boolean )
void showEditor( String, String, Boolean, Object )


Servoy Properties Details


build
String  build
Returns the current version (major, minor, build)
Returns
String  build String

Supported Clients
SmartClient


buildDate
Date  buildDate
Returns date release date
Returns
Date  date Date

Supported Clients
SmartClient


component
String  component
Returns the component name
Returns
String  name String

Supported Clients
SmartClient


licensee
String  licensee
Returns the licensee
Returns
String  licensee String

Supported Clients
SmartClient


typeLicensed
String  typeLicensed
Returns the type that is valid for this license
Returns
String  type String

Supported Clients
SmartClient


useDefaultStyle
Boolean  useDefaultStyle
Use the default style when StyleSheet is not used.
Returns
Boolean  use boolean

Supported Clients
SmartClient


version
Number  version
Returns the current version (major, minor)
Returns
Number  version Double

Supported Clients
SmartClient


versionLicensed
String  versionLicensed
Returns the version that is valid for this license
Returns
String  license String

Supported Clients
SmartClient

Servoy Methods Details


createFolderInRoot
void  createFolderInRoot( String )
Create component folder in the assigned root.
Parameters
String  folderName  the folder name

Returns
void  

Supported Clients
SmartClient


editor
IHEditor  editor( )
Get an htmleditor.
Returns
IHEditor  editor IHEditor

Supported Clients
SmartClient


getEditor
IHEditor  getEditor( Object )
Get an htmleditor per ID.
Parameters
Object  id  the id

Returns
IHEditor  editor IHEditor

Supported Clients
SmartClient


getEditors
Array<Object>  getEditors( )
Get an array of all editors.
Returns
Array<Object>  editors Object[]

Supported Clients
SmartClient


openFile
void  openFile( String, String )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path
String  title  the title

Returns
void  

Supported Clients
SmartClient


openFile
void  openFile( String, String, Boolean, Object )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path
String  title  the title
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient


openFile
void  openFile( String, String, Boolean )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path
String  title  the title
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient


openFile
void  openFile( String, String, Boolean, Object, Function )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path
String  title  the title
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient


openFile
void  openFile( String )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path

Returns
void  

Supported Clients
SmartClient


openFile
void  openFile( String, Boolean, Object )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient


openFile
void  openFile( String, Boolean )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient


openFile
void  openFile( String, Boolean, Object, Function )
Opens the file given in the filePath parameter. Save function in the htmleditor will save the data into the same file. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  filePath  the file path
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String, String )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path
String  title  the title

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String, Boolean, Object )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String, String, Boolean, Object, Function )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path
String  title  the title
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String, String, Boolean )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path
String  title  the title
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String, Boolean, Object, Function )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String, String, Boolean, Object )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path
String  title  the title
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient


openStringSaveInFile
void  openStringSaveInFile( String, String, Boolean )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the file specified by filePath parameter. filePath parameter can be absolute or relative. Relative filePath should be relative to server/webapps/ROOT directory.
Parameters
String  html  the html
String  filePath  the file path
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String, String, Boolean, Object, Function )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String, Boolean, Object, Function )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String, Boolean, Object )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String, String )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String, String, Boolean, Object )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String, Boolean )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openStringSaveinTableColumn
void  openStringSaveinTableColumn( String, String, String, String, String, String, Boolean )
Opens the contents of html parameter. Save function in the htmleditor will save the data into the columen given by server,table and column parameters. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...] .
Parameters
String  html  the html
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient

Sample
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause but replace the content
// Arguments are:
// 1. new html string
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openStringSaveinTableColumn("clean html htmleditor (save to database)", controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String, Boolean, Object )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String, String )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String, Boolean, Object, Function )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String, String, Boolean, Object, Function )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String, String, Boolean )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String, String, Boolean, Object )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
String  title  the title
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String, Boolean )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


openTableColumn
void  openTableColumn( String, String, String, String )
Opens the contents of column in table of server. The row will be selected according to whereCondition Parameter. whereCondition paramenter syntax is [fieldName=value and/or fieldName=value ...]. Save function in the htmleditor will save the data into the same field
Parameters
String  server  the server name
String  table  the table name
String  column  the column name
String  whereCondition  the where condition

Returns
void  

Supported Clients
SmartClient

Sample
// This is component check for sample/demo purposes to make sure there is component record
if (!controller.getMaxRecordIndex()) {
controller.newRecord();
controller.saveData();
}

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
//
// Optional
// 5: resizable
// 6: id (to retrieve from callback method
// 7: method (to override 'global' callback method)
plugins.it2be_htmleditor.openTableColumn(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid = 1")


register
Boolean  register( String )
Register your runtime license (use the Components Manager to request your license string)
Parameters
String  license  the license

Returns
Boolean  result boolean

Supported Clients
SmartClient

Sample
// You have to register your plug-in(s) and beans before you start using them
// One way to do so is create an 'onOpenSolution' method and add the 'register(.)' method(s) there
plugins.it2be_htmleditor.register("Insert the license string(s) from your '*_runtime_license.txt' file here!");


setEditorModal
void  setEditorModal( Boolean )
Make sure component user can open only one htmleditor.
Parameters
Boolean  modal  the modal

Returns
void  

Supported Clients
SmartClient


setHeight
void  setHeight( Number )
Set height.
Parameters
Number  height  the height

Returns
void  

Supported Clients
SmartClient


setMediaFolder
void  setMediaFolder( String )
Set media folder name.
Parameters
String  folderName  the folder name

Returns
void  

Supported Clients
SmartClient


setStyleSheet
void  setStyleSheet( String )
Set Stylesheet arguments: file name, insert into file, relative/absolute.
Parameters
String  filePath  the file path

Returns
void  

Supported Clients
SmartClient


setStyleSheet
void  setStyleSheet( String, Boolean, Boolean )
Set Stylesheet arguments: file name, insert into file, relative/absolute.
Parameters
String  filePath  the file path
Boolean  insert  the insert
Boolean  relative  the relative

Returns
void  

Supported Clients
SmartClient


setStyleSheet
void  setStyleSheet( String, Boolean )
Set Stylesheet arguments: file name, insert into file, relative/absolute.
Parameters
String  filePath  the file path
Boolean  insert  the insert

Returns
void  

Supported Clients
SmartClient


setWidth
void  setWidth( Number )
Set width.
Parameters
Number  width  the width

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String, String )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html
String  title  the title

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String, Boolean, Object, Function )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String, String, Boolean, Object, Function )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html
String  title  the title
Boolean  resizable  the resizable
Object  id  the id
Function  method  the method

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String, Boolean )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String, Boolean, Object )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String, String, Boolean )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html
String  title  the title
Boolean  resizable  the resizable

Returns
void  

Supported Clients
SmartClient


showEditor
void  showEditor( String, String, Boolean, Object )
Opens the htmleditor with component blank Page. Save function in the htmleditor will prompt for component file name and save it in server/webapps/ROOT directory
Parameters
String  html  the html
String  title  the title
Boolean  resizable  the resizable
Object  id  the id

Returns
void  

Supported Clients
SmartClient