jACOB 2.7 API Documentation.

de.tif.jacob.screen.event
Class IBrowserEventHandler

java.lang.Object
  extended by EventHandler
      extended by de.tif.jacob.screen.event.GuiEventHandler
          extended by de.tif.jacob.screen.event.IBrowserEventHandler

public abstract class IBrowserEventHandler
extends GuiEventHandler

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


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
IBrowserEventHandler()
           
 
Method Summary
abstract  java.lang.String filterCell(IClientContext context, IBrowser browser, int row, int column, java.lang.String value)
          Filters the cell data for the given browser.
abstract  void onRecordSelect(IClientContext context, IBrowser browser, IDataTableRecord selectedRecord)
          This hook method will be called, if the user selects a record in the browser.
 
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

IBrowserEventHandler

public IBrowserEventHandler()
Method Detail

filterCell

public abstract java.lang.String filterCell(IClientContext context,
                                            IBrowser browser,
                                            int row,
                                            int column,
                                            java.lang.String value)
                                     throws java.lang.Exception
Filters the cell data for the given browser. A browser can be an in-form browser or a search browser.

Parameters:
context - the current client context
browser - the browser itself
row - the row which can be filtered
column - the column
value - the original value from the database
Returns:
the new value for the browser or null to keep cell empty.
Throws:
java.lang.Exception

onRecordSelect

public abstract void onRecordSelect(IClientContext context,
                                    IBrowser browser,
                                    IDataTableRecord selectedRecord)
                             throws java.lang.Exception
This hook method will be called, if the user selects a record in the browser.

Parameters:
context - the current client context
browser - The browser with the click event
selectedRecord - the record which has been selected
Throws:
java.lang.Exception

jACOB 2.7 API Documentation.