de.tif.jacob.screen.event
Class IForeignFieldEventHandler

java.lang.Object
  EventHandler
      de.tif.jacob.screen.event.GuiEventHandler
          de.tif.jacob.screen.event.IGroupMemberEventHandler
              de.tif.jacob.screen.event.IForeignFieldEventHandler

public abstract class IForeignFieldEventHandler
extends IGroupMemberEventHandler

Abstract event handler class for foreign fields. Derived implementations of this event handler class have to be used to "hook" application-specific business logic to foreign fields.

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.

Constructor Summary

IForeignFieldEventHandler()

Method Summary

boolean	beforeSearch(IClientContext context, IForeignField foreignField) This hook method will be called, if the search icon of the foreign field has been pressed.
void	onDeselect(IClientContext context, IForeignField foreignField) This hook method will be called, if the foreign field has been cleared (deselected).
void	onSelect(IClientContext context, IDataTableRecord foreignRecord, IForeignField foreignField) This hook method will be called, if a record has been filled back (selected) in the foreign field.

Methods inherited from class de.tif.jacob.screen.event.IGroupMemberEventHandler

onGroupStatusChanged, onHide, onShow

Methods inherited from class de.tif.jacob.screen.event.GuiEventHandler

alert, alert, alert

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

Constructor Detail

IForeignFieldEventHandler

public IForeignFieldEventHandler()

Method Detail

beforeSearch

public boolean beforeSearch(IClientContext context,
                            IForeignField foreignField)
                     throws java.lang.Exception

This hook method will be called, if the search icon of the foreign field has been pressed.
You can avoid the search action, if you return false or you can add QBE search constraints to the respective data tables to constraint the search result.

Parameters:

context - The current client context

foreignField - The foreign field itself

Returns:

false, if you want to avoid the execution of the search action, otherwise true

Throws:

java.lang.Exception

onSelect

public void onSelect(IClientContext context,
                     IDataTableRecord foreignRecord,
                     IForeignField foreignField)
              throws java.lang.Exception

This hook method will be called, if a record has been filled back (selected) in the foreign field.

Parameters:

context - The current client context

foreignRecord - The record which has been filled in the foreign field.

foreignField - The foreign field itself

Throws:

java.lang.Exception

onDeselect

public void onDeselect(IClientContext context,
                       IForeignField foreignField)
                throws java.lang.Exception

This hook method will be called, if the foreign field has been cleared (deselected).

Parameters:

context - The current client context

foreignField - The foreign field itself

Throws:

java.lang.Exception