de.tif.jacob.screen
Interface IForm

All Superinterfaces:

IGuiElement

public interface IForm
extends IGuiElement

Nested Class Summary

Nested classes/interfaces inherited from interface de.tif.jacob.screen.IGuiElement

IGuiElement.GroupState

Field Summary

static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Fields inherited from interface de.tif.jacob.screen.IGuiElement

NEW, SEARCH, SELECTED, UNDEFINED, UPDATE

Method Summary

void	clear(IClientContext context) Clears the form.
IBrowser	getCurrentBrowser() Returns the current search browser of the form, i.e. the active browser being displayed on top (of other search browsers, if existing) then the form becomes the current one.
java.lang.String	getInputFieldValue(java.lang.String fieldName) Returns the value of the input field specified by name.
void	resetTabOrder() Resets the current input focus and sets the element with the lowest tab index as the current input element.
void	setCurrentBrowser(IBrowser browser) Sets the current search browser of the form, i.e. the active browser being displayed on top (of other search browsers, if existing) then the form becomes the current one.
void	setInputFieldValue(java.lang.String fieldName, java.lang.String value) Sets the value of an input field specified by name.

Methods inherited from interface de.tif.jacob.screen.IGuiElement

findByName, getApplicationDefinition, getChildren, getDataStatus, getGroupTableAlias, getI18NLabel, getLabel, getName, getParent, getPathName, hasChild, isEnabled, isVisible, setBackgroundColor, setColor, setEnable, setLabel, setVisible

Field Detail

RCS_ID

static final java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

static final java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

Method Detail

setCurrentBrowser

void setCurrentBrowser(IBrowser browser)

Sets the current search browser of the form, i.e. the active browser being displayed on top (of other search browsers, if existing) then the form becomes the current one.

Parameters:

browser - the browser to become the current browser

See Also:

getCurrentBrowser(), IClientContext.setCurrentForm(String), IClientContext.setCurrentForm(String, String)

getCurrentBrowser

IBrowser getCurrentBrowser()

Returns the current search browser of the form, i.e. the active browser being displayed on top (of other search browsers, if existing) then the form becomes the current one.

Returns:

the current search browser of the form

See Also:

setCurrentBrowser(IBrowser), IClientContext.setCurrentForm(String), IClientContext.setCurrentForm(String, String)

clear

void clear(IClientContext context)
           throws java.lang.Exception

Clears the form.

Parameters:

context - The current client context

Throws:

java.lang.Exception - on any problem

setInputFieldValue

void setInputFieldValue(java.lang.String fieldName,
                        java.lang.String value)
                        throws java.lang.Exception

Sets the value of an input field specified by name.

Parameters:

fieldName - the name of the input field, i.e. this is not the name of the associated data field.

value - The new value of the input field.

Throws:

java.lang.Exception - if the field does not exist or is not an input field.

getInputFieldValue

java.lang.String getInputFieldValue(java.lang.String fieldName)
                                    throws java.lang.Exception

Returns the value of the input field specified by name.

Parameters:

fieldName - the name of the input field, i.e. this is not the name of the associated data field.

Returns:

the visible value of the input field

Throws:

java.lang.Exception - if the field does not exist or is not an input field.

resetTabOrder

void resetTabOrder()

Resets the current input focus and sets the element with the lowest tab index as the current input element.