ID
Object  ID

Get/Set the ID (and htmleditor dialog name).

Returns
Object  id Object

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

baseURL
String  baseURL

Get/Set the base (root) URL.

Returns
String  url String

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

content
String  content

Get/Set the current html source.

Returns
String  content String

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

height
Number  height

Set height.

Returns
Number  height int

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

mediaFolder
String  mediaFolder

Set media folder name.

Returns
String  folder String

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

modal
Boolean  modal

Make sure component user can open only one htmleditor (default true).

Returns
Boolean  modal boolean

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

resizable
Boolean  resizable

Set the htmleditor dialog resizable (default true).

Returns
Boolean  resizable boolean

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

saveContentOnSaveButtonClick
Boolean  saveContentOnSaveButtonClick

Get/Set the content to be saved upon clicking the save button.

Returns
Boolean  save boolean

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

title
String  title

Set the htmleditor dialog title.

Returns
String  title String

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

useDefaultStyle
Boolean  useDefaultStyle

Use the default style when StyleSheet is not used.

Returns
Boolean  use boolean

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

width
Number  width

Set width.

Returns
Number  width int

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

close
void  close( )

Close and dispose the htmleditor.

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

lowerToolbar
IHLowerToolbar  lowerToolbar( )

Get the lower toolbar

Returns
IHLowerToolbar  toolbar IHLowerToolbar

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

refresh
void  refresh( String )

Refresh content via scripting, onRefreshMethod will not trigger.

Parameters
String  content  the content

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setContentByPath
void  setContentByPath( String )

Set the path to the html source .

Parameters
String  filePath  the file path

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setContentByQuery
void  setContentByQuery( String, String, String, String )

Set the set the server, table, column and where dbClause to retrieve html source from component database.

Parameters
String  server  the server
String  table  the table
String  column  the column
String  whereClause  the where clause

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setHtmlCursorPositionMethod
void  setHtmlCursorPositionMethod( Function )

Set the callback method for when the cursor is positioned

Parameters
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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setOnCloseMethod
void  setOnCloseMethod( Function )

The callback method that is called when the htmleditor is closed.

Parameters
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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setOnFocusGainedMethod
void  setOnFocusGainedMethod( Function )

The callback method that is called when the htmleditor gains focus.

Parameters
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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setOnMediaSelectedMethod
void  setOnMediaSelectedMethod( Function )

The callback method that is called when media is selected

Parameters
Function  method  the on media selected 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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setOnMediaUploadMethod
void  setOnMediaUploadMethod( Function )

The method that is called when files are oploaded to the media folder (returns id and array of filenames).

Parameters
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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setOnRefreshMethod
void  setOnRefreshMethod( Function )

The callback method that is called when the refresh button is clicked.

Parameters
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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setOnSaveMethod
void  setOnSaveMethod( Function )

The callback method that is called when the source is saved (optional argument to really save or only call saveMethod).

Parameters
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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setOnSaveMethod
void  setOnSaveMethod( Function, Boolean )

The callback method that is called when the source is saved (optional argument to really save or only call saveMethod).

Parameters
Function  method  the method
Boolean  saveOnClick  the save on click

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

setSourceCursorPositionMethod
void  setSourceCursorPositionMethod( Function )

The callback method to call when a cursor is position in the source panel

Parameters
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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

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

Sample

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

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

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

Sample

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

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

show
void  show( )

Show the htmleditor.

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton

upperToolbar
IHUpperToolbar  upperToolbar( )

Get the upper toolbar

Returns
IHUpperToolbar  toolbar IHUpperToolbar

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();
}

// Create component HTML htmleditor
var htmleditor = plugins.it2be_htmleditor.htmleditor();

// Start editing component database field, selected with the clause
// Arguments are:
// 1: server name,
// 2: table name,
// 3: column name,
// 4: where clause
htmleditor.setContentByQuery(controller.getServerName(), "it2be_htmleditor", "html", "it2be_htmleditorid=1");

// By adding component content string the actual file content will be disregarded!
htmleditor.content = "Clean html htmleditor.

Disregard actual content!";

// The onCloseMethod is called when the Window is closed
htmleditor.setOnCloseMethod(editorOnCloseMethod);

// The onRefreshMethod is called by the refreshButton
htmleditor.setOnRefreshMethod(editorRefreshMethod);

// The onRefreshMethod is called by the saveButton