com.servoy.j2db
Interface IForm

public interface IForm

Interface for manipulating a form

Field Summary

static int	LIST_VIEW Constant for method setView(...) to show in listview.
static int	LOCKED_RECORD_VIEW
static int	RECORD_VIEW Constant for method setView(...) to show in recordview.

Method Summary

boolean	deleteAllRecords() Delete all records in foundset.
boolean	deleteRecord() Delete current record.
void	duplicateRecord() Duplicate current record.
Object	eval(String javascript) Eval a javascript
void	find() Enter the find.
String	getDataSource()
IFoundSet	getFoundSet()
String	getName() Get the form name
ITable	getTable() Deprecated.
int	getView() get the current view (see constants).
void	invertRecords() Invert the foundset.
boolean	isInFindMode() Check if in find.
boolean	isShowingData() Method to check if this form had record data.
void	loadAllRecords() Show all records from table.
void	newRecord() Make new record.
void	omitRecord() Omit a record.
int	performFind(boolean clear, boolean reduce, boolean showDialogOnNoResults) Perform a find (called search() in javascript).
void	print(boolean showManyRecordsDialog, boolean printCurrentRecordOnly, boolean showPrinterSelectDialog, PrinterJob printerJob) Print records use.
void	printPreview() preview current records.
void	reLookupValues() do reLookupValues on current record.
void	removeLastFound() Prevents always doing a find in find.
Object	setUsingAsExternalComponent(boolean external) When using a form as an external component, this flag has to be set and cleared when done with it.
void	setView(int v) Set the current view (see constants).
void	showOmittedRecords() Show all omitted records as foundset.
void	showSortDialog() Show the sort dialog.

Field Detail

LIST_VIEW

static final int LIST_VIEW

Constant for method setView(...) to show in listview.

See Also:

Constant Field Values

LOCKED_RECORD_VIEW

static final int LOCKED_RECORD_VIEW

See Also:

Constant Field Values

RECORD_VIEW

static final int RECORD_VIEW

Constant for method setView(...) to show in recordview.

See Also:

Constant Field Values

Method Detail

deleteAllRecords

boolean deleteAllRecords()

Delete all records in foundset.

deleteRecord

boolean deleteRecord()

Delete current record.

duplicateRecord

void duplicateRecord()

Duplicate current record.

eval

Object eval(String javascript)

Eval a javascript

Since:

Servoy 3.5

find

void find()

Enter the find.

getDataSource

String getDataSource()

Since:

Servoy 5.0

getFoundSet

IFoundSet getFoundSet()

Returns:

the current foundset

Since:

5.0

getName

String getName()

Get the form name

Since:

3.5

getTable

@Deprecated
ITable getTable()

Deprecated.

getView

int getView()

get the current view (see constants).

Returns:

the view type

invertRecords

void invertRecords()

Invert the foundset.

isInFindMode

boolean isInFindMode()

Check if in find.

isShowingData

boolean isShowingData()

Method to check if this form had record data.

Returns:

boolean normally returs true, if not use loadAllRecords().

loadAllRecords

void loadAllRecords()

Show all records from table.

newRecord

void newRecord()

Make new record.

omitRecord

void omitRecord()

Omit a record.

performFind

int performFind(boolean clear,
                boolean reduce,
                boolean showDialogOnNoResults)

Perform a find (called search() in javascript).

Parameters:

reduce - true if find in find, otherwise it is expand search

showDialogOnNoResults - true shows dialog

print

void print(boolean showManyRecordsDialog,
           boolean printCurrentRecordOnly,
           boolean showPrinterSelectDialog,
           PrinterJob printerJob)

Print records use.

printPreview

void printPreview()

preview current records.

reLookupValues

void reLookupValues()

do reLookupValues on current record.

removeLastFound

void removeLastFound()

Prevents always doing a find in find.

setUsingAsExternalComponent

Object setUsingAsExternalComponent(boolean external)
                                   throws ServoyException

When using a form as an external component, this flag has to be set and cleared when done with it. If you call this in the webclient then the returning component will be a FormUI wicket component with the wicket:id of "webform" So you have to add a placeholder in your bean html file like: <div wicket:id="webform"></div>

Throws:

ServoyException

Since:

Servoy 2.2

setView

void setView(int v)

Set the current view (see constants).

Parameters:

v -

showOmittedRecords

void showOmittedRecords()

Show all omitted records as foundset.

showSortDialog

void showSortDialog()
                    throws Exception

Show the sort dialog.

Throws:

Exception