de.tif.jacob.screen
Interface IGroup

All Superinterfaces:

IGuiElement

public interface IGroup
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 group.
void	clear(IClientContext context, boolean clearSearchBrowser) Clears the group.
IBrowser	getBrowser() Returns the associated search browser of this group.
ISingleDataGuiElement	getFirstElementInTabOrder() Returns the element with the lowest tab index, i.e. the first element in tab order.
java.lang.String	getInputFieldValue(java.lang.String fieldName) Returns the value of the input field specified by name.
void	setBorder(boolean flag) Enable or disable the border of this group.
void	setInputFieldValue(java.lang.String fieldName, java.math.BigDecimal value) Sets the value given as decimal of an input field specified by name.
void	setInputFieldValue(java.lang.String fieldName, java.util.Date value) Sets the value given as date of an input field specified by name.
void	setInputFieldValue(java.lang.String fieldName, java.lang.Double value) Sets the value given as double of an input field specified by name.
void	setInputFieldValue(java.lang.String fieldName, java.lang.Float value) Sets the value given as float of an input field specified by name.
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

getBrowser

IBrowser getBrowser()

Returns the associated search browser of this group.

Returns:

the associated search browser

See Also:

IForm.getCurrentBrowser(), IForm.setCurrentBrowser(IBrowser)

clear

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

Clears the group.

Note: This method is equivalent to clear(IClientContext, boolean), if the second argument is set to true.

Parameters:

context - The current client context

Throws:

java.lang.Exception - on any problem

clear

void clear(IClientContext context,
           boolean clearSearchBrowser)
           throws java.lang.Exception

Clears the group.

Parameters:

context - The current client context

clearSearchBrowser - if true the associated search browser will be cleared as well.

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.

setInputFieldValue

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

Sets the value given as decimal of an input field specified by name.

The decimal value will be converted to the string presentation of the corresponding locale, i.e. the locale of the current user.

Parameters:

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

value - The new decimal value of the input field.

Throws:

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

setInputFieldValue

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

Sets the value given as double of an input field specified by name.

The double value will be converted to the string presentation of the corresponding locale, i.e. the locale of the current user.

Parameters:

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

value - The new double value of the input field.

Throws:

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

setInputFieldValue

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

Sets the value given as float of an input field specified by name.

The float value will be converted to the string presentation of the corresponding locale, i.e. the locale of the current user.

Parameters:

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

value - The new float value of the input field.

Throws:

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

setInputFieldValue

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

Sets the value given as date of an input field specified by name.

The date value will be converted to the string presentation of the corresponding locale, i.e. the locale of the current user.

Parameters:

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

value - The new date 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

Returns:

the visible value of the input field

Throws:

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

getFirstElementInTabOrder

ISingleDataGuiElement getFirstElementInTabOrder()

Returns the element with the lowest tab index, i.e. the first element in tab order.

setBorder

void setBorder(boolean flag)

Enable or disable the border of this group.

Parameters:

flag - The border visibility.

Since:

2.6